com.incesoft.botplatform.sdk
Interface RobotUser

All Known Implementing Classes:
User

public interface RobotUser

Author:
LiBo

Field Summary
static int FLAG_CLIENT_VERSION_6_0
          Client version 6.0
static int FLAG_CLIENT_VERSION_6_1
          Client version 6.1
static int FLAG_CLIENT_VERSION_6_2
          Client version 6.2
static int FLAG_CLIENT_VERSION_7_0
          Client version 7.0
static int FLAG_DIRECT_WATCH
          Direct Watch enabled flag
static int FLAG_FEDERATED_BUDDY
          The user is a federated client.
static int FLAG_GIF_INK_AWARENESS
          User online GIF/ink awareness
static int FLAG_ISF_INK_AWARENESS
          User online ISF/ink awareness
static int FLAG_MOBILE_BUDDY
          The user is a mobile buddy.
static int FLAG_MOBILE_CLIENT
          User is online via Mobile
static int FLAG_MOBILE_IM
          Mobile IMs permitted flag
static int FLAG_MSG_CHUNKING
          Support of message chunking (to allow larger messages over SB)
static int FLAG_MSN_CLIENT
          User online with the MSN client
static int FLAG_MSN_SPACE
          The user has its HasSpace bit set
static int FLAG_P2P_IM
          The user supports Peer-to-Peer IM
static int FLAG_WEB_CAMERA
          There is a web camera on user's machine
static int FLAG_WEB_CLIENT
          The user is online via the web client
static int FLAG_WINKS_SUPPORT
          The user supports Winks
static java.lang.String STATUS_AWAY
          User is away
static java.lang.String STATUS_BE_RIGHT_BACK
          User will be right back
static java.lang.String STATUS_BUSY
          User is busy
static java.lang.String STATUS_HIDDEN
          User is hidden
static java.lang.String STATUS_IDLE
          User is idle
static java.lang.String STATUS_OFFLINE
          User is offline
static java.lang.String STATUS_ON_THE_PHONE
          User is on the phone
static java.lang.String STATUS_ONLINE
          User is online
static java.lang.String STATUS_OUT_TO_LUNCH
          User is out to lunch
 
Method Summary
 long getClientID()
          Get user's client capabilities
 java.lang.String getFriendlyName()
          Get user's friendly name
 java.lang.String getID()
          Get user's identifier (MSN account)
 java.lang.String getStatus()
          Get user's status
 

Field Detail

STATUS_ONLINE

static final java.lang.String STATUS_ONLINE
User is online

See Also:
Constant Field Values

STATUS_OFFLINE

static final java.lang.String STATUS_OFFLINE
User is offline

See Also:
Constant Field Values

STATUS_HIDDEN

static final java.lang.String STATUS_HIDDEN
User is hidden

See Also:
Constant Field Values

STATUS_BUSY

static final java.lang.String STATUS_BUSY
User is busy

See Also:
Constant Field Values

STATUS_IDLE

static final java.lang.String STATUS_IDLE
User is idle

See Also:
Constant Field Values

STATUS_BE_RIGHT_BACK

static final java.lang.String STATUS_BE_RIGHT_BACK
User will be right back

See Also:
Constant Field Values

STATUS_AWAY

static final java.lang.String STATUS_AWAY
User is away

See Also:
Constant Field Values

STATUS_ON_THE_PHONE

static final java.lang.String STATUS_ON_THE_PHONE
User is on the phone

See Also:
Constant Field Values

STATUS_OUT_TO_LUNCH

static final java.lang.String STATUS_OUT_TO_LUNCH
User is out to lunch

See Also:
Constant Field Values

FLAG_MOBILE_CLIENT

static final int FLAG_MOBILE_CLIENT
User is online via Mobile

See Also:
Constant Field Values

FLAG_MSN_CLIENT

static final int FLAG_MSN_CLIENT
User online with the MSN client

See Also:
Constant Field Values

FLAG_GIF_INK_AWARENESS

static final int FLAG_GIF_INK_AWARENESS
User online GIF/ink awareness

See Also:
Constant Field Values

FLAG_ISF_INK_AWARENESS

static final int FLAG_ISF_INK_AWARENESS
User online ISF/ink awareness

See Also:
Constant Field Values

FLAG_WEB_CAMERA

static final int FLAG_WEB_CAMERA
There is a web camera on user's machine

See Also:
Constant Field Values

FLAG_MSG_CHUNKING

static final int FLAG_MSG_CHUNKING
Support of message chunking (to allow larger messages over SB)

See Also:
Constant Field Values

FLAG_MOBILE_IM

static final int FLAG_MOBILE_IM
Mobile IMs permitted flag

See Also:
Constant Field Values

FLAG_DIRECT_WATCH

static final int FLAG_DIRECT_WATCH
Direct Watch enabled flag

See Also:
Constant Field Values

FLAG_WEB_CLIENT

static final int FLAG_WEB_CLIENT
The user is online via the web client

See Also:
Constant Field Values

FLAG_MOBILE_BUDDY

static final int FLAG_MOBILE_BUDDY
The user is a mobile buddy. The flag can be thought of as the Mobile buddy bit which indicates that the buddy is on a mobile device and the mobile properties

See Also:
Constant Field Values

FLAG_FEDERATED_BUDDY

static final int FLAG_FEDERATED_BUDDY
The user is a federated client. The flag can be thought of as the Federated client bit which indicates that the buddy is connected on a client that does not connect directly to the MSN Messenger service

See Also:
Constant Field Values

FLAG_MSN_SPACE

static final int FLAG_MSN_SPACE
The user has its HasSpace bit set

See Also:
Constant Field Values

FLAG_P2P_IM

static final int FLAG_P2P_IM
The user supports Peer-to-Peer IM

See Also:
Constant Field Values

FLAG_WINKS_SUPPORT

static final int FLAG_WINKS_SUPPORT
The user supports Winks

See Also:
Constant Field Values

FLAG_CLIENT_VERSION_6_0

static final int FLAG_CLIENT_VERSION_6_0
Client version 6.0

See Also:
Constant Field Values

FLAG_CLIENT_VERSION_6_1

static final int FLAG_CLIENT_VERSION_6_1
Client version 6.1

See Also:
Constant Field Values

FLAG_CLIENT_VERSION_6_2

static final int FLAG_CLIENT_VERSION_6_2
Client version 6.2

See Also:
Constant Field Values

FLAG_CLIENT_VERSION_7_0

static final int FLAG_CLIENT_VERSION_7_0
Client version 7.0

See Also:
Constant Field Values
Method Detail

getID

java.lang.String getID()
Get user's identifier (MSN account)


getFriendlyName

java.lang.String getFriendlyName()
Get user's friendly name


getStatus

java.lang.String getStatus()
Get user's status

Returns:
user's status
NLN - online
FLN - offline
HDN - hidden
BSY - busy
IDL - idle
BRB - be right back
AWY - away
PHN - on the phone
LUN - out to lunch

getClientID

long getClientID()
Get user's client capabilities

Returns:
Client ID
  • 0x00000001 - User is online via Mobile
  • 0x00000002 - User online with the MSN client
  • 0x00000004 - User online GIF/ink awareness
  • 0x00000008 - User online ISF/ink awareness
  • 0x00000010 - There is a web camera on user's machine
  • 0x00000020 - Support of message chunking (to allow larger messages over SB)
  • 0x00000040 - Mobile IMs permitted flag
  • 0x00000080 - Direct Watch enabled flag
  • 0x00000200 - The user is online via the web client
  • 0x00000400 - The user is a mobile buddy.The flag can be thought of as the Mobile buddy bit which indicates that the buddy is on a mobile device and the mobile properties
  • 0x00000800 - The user is a federated client.The flag can be thought of as the Federated client bit which indicates that the buddy is connected on a client that does not connect directly to the MSN Messenger service
  • 0x00001000 - The user has its HasSpace bit set
  • 0x00004000 - The user supports Peer-to-Peer IM
  • 0x00008000 - The user supports Winks
  • 0x10000000 - Client version 6.0
  • 0x20000000 - Client version 6.1
  • 0x30000000 - Client version 6.2
  • 0x40000000 - Client version 7.0