com.incesoft.botplatform.sdk
Class RobotAdapter

java.lang.Object
  extended by com.incesoft.botplatform.sdk.RobotAdapter
All Implemented Interfaces:
RobotHandler

public class RobotAdapter
extends java.lang.Object
implements RobotHandler


Constructor Summary
RobotAdapter()
           
 
Method Summary
 void activityAccepted(RobotSession session)
          Occurs when user accepts an activity (P4) invitation
 void activityClosed(RobotSession session)
          Occurs when the activity associated with this session is closed.
 void activityLoaded(RobotSession session)
          Occurs when the activity associated with this session loaded.
 void activityReceived(RobotSession session, java.lang.String data)
          Occurs when robot receives a user's activity-data( ms activity sdk -> Channel.SendData(...) )
 void activityRejected(RobotSession session)
          Occurs when user rejects an activity (P4) invitation
 void colorSchemeUpdated(java.lang.String robot, java.lang.String user, int colorScheme)
           
 void contactListReceived(java.lang.String robot, java.util.List<RobotUser> contactList)
          Occurs when robot receives contact list.
 void displayPictureUpdated(java.lang.String robot, java.lang.String user, RobotResource resource)
          Occurs when a user changes display picture .
 void exceptionCaught(RobotSession session, java.lang.Throwable cause)
          Occurs when BOTPLATFORM server throws an exception associated with this session
 void fileAccepted(RobotSession session, RobotFileDescriptor invitation)
          Occurs when user accepts a file transfer invitation.
 void fileInvited(RobotSession session, RobotFileDescriptor fileDescriptor)
          Occurs when a file invite request is received.
 void fileReceived(java.lang.String robot, java.lang.String user, RobotFileDescriptor fileDescriptor, java.lang.String saveUrl)
          Occurs when a file has been saved to the saveUrl.
 void fileRejected(RobotSession session, RobotFileDescriptor fileDescriptor)
          Occurs when user rejects a file transfer invitation.
 void fileTransferCancelled(RobotSession session, RobotFileDescriptor fileDescriptor)
          Occurs when a file transfer cancelled.
 void fileTransferEnded(RobotSession session, RobotFileDescriptor fileDescriptor)
          Occurs when a file transfer ended.
 void fileTransferError(RobotSession session, RobotFileDescriptor fileDescriptor)
          Occurs when a file transfer encounters an error.
 void inkReceived(RobotSession session, byte[] ink)
          Occurs when robot receives ink message .
 void messageReceived(RobotSession session, RobotMessage message)
          Occurs when robot receives a user's message
 void nudgeReceived(RobotSession session)
          Occurs when robot receives a user's nudge
 void personalMessageUpdated(java.lang.String robot, java.lang.String user, java.lang.String personalMessage)
          Occurs when user changes personal message.
 void resourceReceived(java.lang.String robot, java.lang.String user, RobotResource resource, java.lang.String saveUrl)
          Occurs when a resource has been saved to the saveUrl.
 void sceneUpdated(java.lang.String robot, java.lang.String user, RobotResource resource)
          Occurs when user changes scene.
 void sessionClosed(RobotSession session)
          Occurs when user leaves a session (session closes), which is caused by a user closes a conversation window or session timeout.
 void sessionOpened(RobotSession session)
          Occurs when robot receives a user's chat request (session setup), which is caused by a user opens a conversation window or session timeout and then reconnects.
 void typingReceived(RobotSession session)
          Occurs user is inputting messages.
 void userAdd(java.lang.String robot, java.lang.String user)
          Occurs when user adds the robot to his friend list.
 void userJoined(RobotSession session, RobotUser user)
          Occurs when the a user joins the current conversation.
 void userLeft(RobotSession session, RobotUser user)
          Occurs when the a user leaves the current conversation.
 void userRemove(java.lang.String robot, java.lang.String user)
          Occurs when user removes the robot from his friend list
 void userUpdated(java.lang.String robot, RobotUser user)
          Occurs when user changes nickname or status.
 void voiceclipReceived(RobotSession session, RobotResource resource)
          Occurs when robot receives voice clip .
 void webcamAccepted(RobotSession session)
          Occurs when user accepts a webcam invitation.
 void webcamRejected(RobotSession session)
          Occurs when user rejects a webcam invitation.
 void winkReceived(RobotSession session, RobotResource resource)
          Occurs when robot receives wink message.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RobotAdapter

public RobotAdapter()
Method Detail

activityAccepted

public void activityAccepted(RobotSession session)
                      throws RobotException
Description copied from interface: RobotHandler
Occurs when user accepts an activity (P4) invitation

Specified by:
activityAccepted in interface RobotHandler
Throws:
RobotException

activityClosed

public void activityClosed(RobotSession session)
                    throws RobotException
Description copied from interface: RobotHandler
Occurs when the activity associated with this session is closed.

Specified by:
activityClosed in interface RobotHandler
Throws:
RobotException

activityLoaded

public void activityLoaded(RobotSession session)
                    throws RobotException
Description copied from interface: RobotHandler
Occurs when the activity associated with this session loaded.

Specified by:
activityLoaded in interface RobotHandler
Throws:
RobotException

activityReceived

public void activityReceived(RobotSession session,
                             java.lang.String data)
                      throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives a user's activity-data( ms activity sdk -> Channel.SendData(...) )

Specified by:
activityReceived in interface RobotHandler
Throws:
RobotException

activityRejected

public void activityRejected(RobotSession session)
                      throws RobotException
Description copied from interface: RobotHandler
Occurs when user rejects an activity (P4) invitation

Specified by:
activityRejected in interface RobotHandler
Throws:
RobotException

colorSchemeUpdated

public void colorSchemeUpdated(java.lang.String robot,
                               java.lang.String user,
                               int colorScheme)
                        throws RobotException
Specified by:
colorSchemeUpdated in interface RobotHandler
Parameters:
robot - robot account.
user - user who changes color scheme.
colorScheme - color
Throws:
RobotException

contactListReceived

public void contactListReceived(java.lang.String robot,
                                java.util.List<RobotUser> contactList)
                         throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives contact list.

Specified by:
contactListReceived in interface RobotHandler
Parameters:
robot - robot account.
contactList - a list contains the account's friend list (see RobotUser).
Throws:
RobotException

displayPictureUpdated

public void displayPictureUpdated(java.lang.String robot,
                                  java.lang.String user,
                                  RobotResource resource)
                           throws RobotException
Description copied from interface: RobotHandler
Occurs when a user changes display picture .

Specified by:
displayPictureUpdated in interface RobotHandler
Parameters:
robot - robot account.
user - user who changes display picture.
resource - a descriptor of the display picture (see RobotResource).
Throws:
RobotException

exceptionCaught

public void exceptionCaught(RobotSession session,
                            java.lang.Throwable cause)
                     throws RobotException
Description copied from interface: RobotHandler
Occurs when BOTPLATFORM server throws an exception associated with this session

Specified by:
exceptionCaught in interface RobotHandler
Throws:
RobotException

fileAccepted

public void fileAccepted(RobotSession session,
                         RobotFileDescriptor invitation)
                  throws RobotException
Description copied from interface: RobotHandler
Occurs when user accepts a file transfer invitation.

Specified by:
fileAccepted in interface RobotHandler
Throws:
RobotException

fileInvited

public void fileInvited(RobotSession session,
                        RobotFileDescriptor fileDescriptor)
                 throws RobotException
Description copied from interface: RobotHandler
Occurs when a file invite request is received.

Specified by:
fileInvited in interface RobotHandler
Throws:
RobotException

fileRejected

public void fileRejected(RobotSession session,
                         RobotFileDescriptor fileDescriptor)
                  throws RobotException
Description copied from interface: RobotHandler
Occurs when user rejects a file transfer invitation.

Specified by:
fileRejected in interface RobotHandler
Throws:
RobotException

fileTransferCancelled

public void fileTransferCancelled(RobotSession session,
                                  RobotFileDescriptor fileDescriptor)
                           throws RobotException
Description copied from interface: RobotHandler
Occurs when a file transfer cancelled.

Specified by:
fileTransferCancelled in interface RobotHandler
Throws:
RobotException

fileTransferEnded

public void fileTransferEnded(RobotSession session,
                              RobotFileDescriptor fileDescriptor)
                       throws RobotException
Description copied from interface: RobotHandler
Occurs when a file transfer ended.

Specified by:
fileTransferEnded in interface RobotHandler
Throws:
RobotException

fileTransferError

public void fileTransferError(RobotSession session,
                              RobotFileDescriptor fileDescriptor)
                       throws RobotException
Description copied from interface: RobotHandler
Occurs when a file transfer encounters an error.

Specified by:
fileTransferError in interface RobotHandler
Throws:
RobotException

inkReceived

public void inkReceived(RobotSession session,
                        byte[] ink)
                 throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives ink message .

Specified by:
inkReceived in interface RobotHandler
ink - the data of the received ink message.
Throws:
RobotException

messageReceived

public void messageReceived(RobotSession session,
                            RobotMessage message)
                     throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives a user's message

Specified by:
messageReceived in interface RobotHandler
message - Received message
Throws:
RobotException

nudgeReceived

public void nudgeReceived(RobotSession session)
                   throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives a user's nudge

Specified by:
nudgeReceived in interface RobotHandler
Throws:
RobotException

personalMessageUpdated

public void personalMessageUpdated(java.lang.String robot,
                                   java.lang.String user,
                                   java.lang.String personalMessage)
                            throws RobotException
Description copied from interface: RobotHandler
Occurs when user changes personal message.

Specified by:
personalMessageUpdated in interface RobotHandler
Throws:
RobotException

sceneUpdated

public void sceneUpdated(java.lang.String robot,
                         java.lang.String user,
                         RobotResource resource)
                  throws RobotException
Description copied from interface: RobotHandler
Occurs when user changes scene.

Specified by:
sceneUpdated in interface RobotHandler
resource - a descriptor of the received scene (see RobotResource).
Throws:
RobotException

sessionClosed

public void sessionClosed(RobotSession session)
                   throws RobotException
Description copied from interface: RobotHandler
Occurs when user leaves a session (session closes), which is caused by a user closes a conversation window or session timeout.

Specified by:
sessionClosed in interface RobotHandler
Throws:
RobotException

sessionOpened

public void sessionOpened(RobotSession session)
                   throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives a user's chat request (session setup), which is caused by a user opens a conversation window or session timeout and then reconnects.

Specified by:
sessionOpened in interface RobotHandler
Throws:
RobotException

typingReceived

public void typingReceived(RobotSession session)
                    throws RobotException
Description copied from interface: RobotHandler
Occurs user is inputting messages.

Specified by:
typingReceived in interface RobotHandler
Throws:
RobotException

userAdd

public void userAdd(java.lang.String robot,
                    java.lang.String user)
             throws RobotException
Description copied from interface: RobotHandler
Occurs when user adds the robot to his friend list.

Specified by:
userAdd in interface RobotHandler
Throws:
RobotException

userJoined

public void userJoined(RobotSession session,
                       RobotUser user)
                throws RobotException
Description copied from interface: RobotHandler
Occurs when the a user joins the current conversation.

Specified by:
userJoined in interface RobotHandler
Throws:
RobotException

userLeft

public void userLeft(RobotSession session,
                     RobotUser user)
              throws RobotException
Description copied from interface: RobotHandler
Occurs when the a user leaves the current conversation.

Specified by:
userLeft in interface RobotHandler
Throws:
RobotException

userRemove

public void userRemove(java.lang.String robot,
                       java.lang.String user)
                throws RobotException
Description copied from interface: RobotHandler
Occurs when user removes the robot from his friend list

Specified by:
userRemove in interface RobotHandler
Throws:
RobotException

userUpdated

public void userUpdated(java.lang.String robot,
                        RobotUser user)
                 throws RobotException
Description copied from interface: RobotHandler
Occurs when user changes nickname or status.

Specified by:
userUpdated in interface RobotHandler
Throws:
RobotException

voiceclipReceived

public void voiceclipReceived(RobotSession session,
                              RobotResource resource)
                       throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives voice clip .

Specified by:
voiceclipReceived in interface RobotHandler
resource - a descriptor of the received voice clip (see RobotResource).
Throws:
RobotException

webcamAccepted

public void webcamAccepted(RobotSession session)
                    throws RobotException
Description copied from interface: RobotHandler
Occurs when user accepts a webcam invitation.

Specified by:
webcamAccepted in interface RobotHandler
Throws:
RobotException

webcamRejected

public void webcamRejected(RobotSession session)
                    throws RobotException
Description copied from interface: RobotHandler
Occurs when user rejects a webcam invitation.

Specified by:
webcamRejected in interface RobotHandler
Throws:
RobotException

winkReceived

public void winkReceived(RobotSession session,
                         RobotResource resource)
                  throws RobotException
Description copied from interface: RobotHandler
Occurs when robot receives wink message.

Specified by:
winkReceived in interface RobotHandler
resource - a descriptor of the received wink message (see RobotResource).
Throws:
RobotException

fileReceived

public void fileReceived(java.lang.String robot,
                         java.lang.String user,
                         RobotFileDescriptor fileDescriptor,
                         java.lang.String saveUrl)
Description copied from interface: RobotHandler
Occurs when a file has been saved to the saveUrl.

Specified by:
fileReceived in interface RobotHandler

resourceReceived

public void resourceReceived(java.lang.String robot,
                             java.lang.String user,
                             RobotResource resource,
                             java.lang.String saveUrl)
Description copied from interface: RobotHandler
Occurs when a resource has been saved to the saveUrl.

Specified by:
resourceReceived in interface RobotHandler