com.incesoft.botplatform.sdk.protocol.msg
Class User

java.lang.Object
  extended by com.incesoft.botplatform.sdk.protocol.msg.User
All Implemented Interfaces:
RobotUser, java.io.Serializable

public class User
extends java.lang.Object
implements RobotUser, java.io.Serializable

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.incesoft.botplatform.sdk.RobotUser
FLAG_CLIENT_VERSION_6_0, FLAG_CLIENT_VERSION_6_1, FLAG_CLIENT_VERSION_6_2, FLAG_CLIENT_VERSION_7_0, FLAG_DIRECT_WATCH, FLAG_FEDERATED_BUDDY, FLAG_GIF_INK_AWARENESS, FLAG_ISF_INK_AWARENESS, FLAG_MOBILE_BUDDY, FLAG_MOBILE_CLIENT, FLAG_MOBILE_IM, FLAG_MSG_CHUNKING, FLAG_MSN_CLIENT, FLAG_MSN_SPACE, FLAG_P2P_IM, FLAG_WEB_CAMERA, FLAG_WEB_CLIENT, FLAG_WINKS_SUPPORT, STATUS_AWAY, STATUS_BE_RIGHT_BACK, STATUS_BUSY, STATUS_HIDDEN, STATUS_IDLE, STATUS_OFFLINE, STATUS_ON_THE_PHONE, STATUS_ONLINE, STATUS_OUT_TO_LUNCH
 
Constructor Summary
User()
           
 
Method Summary
 long getClientID()
          Get user's client capabilities
 java.lang.String getFriendlyName()
          Get user's friendly name
 java.lang.String getId()
           
 java.lang.String getID()
          Get user's identifier (MSN account)
 java.lang.String getStatus()
          Get user's status
 void setClientID(long clientID)
           
 void setFriendlyName(java.lang.String friendlyName)
           
 void setId(java.lang.String id)
           
 void setStatus(java.lang.String status)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

User

public User()
Method Detail

getID

public java.lang.String getID()
Description copied from interface: RobotUser
Get user's identifier (MSN account)

Specified by:
getID in interface RobotUser

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getFriendlyName

public java.lang.String getFriendlyName()
Description copied from interface: RobotUser
Get user's friendly name

Specified by:
getFriendlyName in interface RobotUser

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

getStatus

public java.lang.String getStatus()
Description copied from interface: RobotUser
Get user's status

Specified by:
getStatus in interface RobotUser
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

setStatus

public void setStatus(java.lang.String status)

getClientID

public long getClientID()
Description copied from interface: RobotUser
Get user's client capabilities

Specified by:
getClientID in interface RobotUser
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

setClientID

public void setClientID(long clientID)