com.incesoft.botplatform.sdk
Interface RobotHandler

All Known Implementing Classes:
RobotAdapter

public interface RobotHandler

Robot event handler

Author:
LiBo

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.
 

Method Detail

sessionOpened

void sessionOpened(RobotSession session)
                   throws RobotException
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.

Throws:
RobotException

sessionClosed

void sessionClosed(RobotSession session)
                   throws RobotException
Occurs when user leaves a session (session closes), which is caused by a user closes a conversation window or session timeout.

Throws:
RobotException

messageReceived

void messageReceived(RobotSession session,
                     RobotMessage message)
                     throws RobotException
Occurs when robot receives a user's message

Parameters:
message - Received message
Throws:
RobotException

nudgeReceived

void nudgeReceived(RobotSession session)
                   throws RobotException
Occurs when robot receives a user's nudge

Throws:
RobotException

activityAccepted

void activityAccepted(RobotSession session)
                      throws RobotException
Occurs when user accepts an activity (P4) invitation

Throws:
RobotException

activityRejected

void activityRejected(RobotSession session)
                      throws RobotException
Occurs when user rejects an activity (P4) invitation

Throws:
RobotException

activityReceived

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

Throws:
RobotException

activityLoaded

void activityLoaded(RobotSession session)
                    throws RobotException
Occurs when the activity associated with this session loaded.

Throws:
RobotException

activityClosed

void activityClosed(RobotSession session)
                    throws RobotException
Occurs when the activity associated with this session is closed.

Throws:
RobotException

userJoined

void userJoined(RobotSession session,
                RobotUser user)
                throws RobotException
Occurs when the a user joins the current conversation.

Throws:
RobotException

userLeft

void userLeft(RobotSession session,
              RobotUser user)
              throws RobotException
Occurs when the a user leaves the current conversation.

Throws:
RobotException

userAdd

void userAdd(java.lang.String robot,
             java.lang.String user)
             throws RobotException
Occurs when user adds the robot to his friend list.

Parameters:
user -
Throws:
RobotException

userRemove

void userRemove(java.lang.String robot,
                java.lang.String user)
                throws RobotException
Occurs when user removes the robot from his friend list

Parameters:
user -
Throws:
RobotException

exceptionCaught

void exceptionCaught(RobotSession session,
                     java.lang.Throwable cause)
                     throws RobotException
Occurs when BOTPLATFORM server throws an exception associated with this session

Throws:
RobotException

fileAccepted

void fileAccepted(RobotSession session,
                  RobotFileDescriptor invitation)
                  throws RobotException
Occurs when user accepts a file transfer invitation.

Throws:
RobotException

fileRejected

void fileRejected(RobotSession session,
                  RobotFileDescriptor fileDescriptor)
                  throws RobotException
Occurs when user rejects a file transfer invitation.

Throws:
RobotException

fileTransferEnded

void fileTransferEnded(RobotSession session,
                       RobotFileDescriptor fileDescriptor)
                       throws RobotException
Occurs when a file transfer ended.

Throws:
RobotException

fileTransferCancelled

void fileTransferCancelled(RobotSession session,
                           RobotFileDescriptor fileDescriptor)
                           throws RobotException
Occurs when a file transfer cancelled.

Throws:
RobotException

fileTransferError

void fileTransferError(RobotSession session,
                       RobotFileDescriptor fileDescriptor)
                       throws RobotException
Occurs when a file transfer encounters an error.

Throws:
RobotException

fileReceived

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.


fileInvited

void fileInvited(RobotSession session,
                 RobotFileDescriptor fileDescriptor)
                 throws RobotException
Occurs when a file invite request is received.

Throws:
RobotException

webcamAccepted

void webcamAccepted(RobotSession session)
                    throws RobotException
Occurs when user accepts a webcam invitation.

Throws:
RobotException

webcamRejected

void webcamRejected(RobotSession session)
                    throws RobotException
Occurs when user rejects a webcam invitation.

Throws:
RobotException

userUpdated

void userUpdated(java.lang.String robot,
                 RobotUser user)
                 throws RobotException
Occurs when user changes nickname or status.

Throws:
RobotException

personalMessageUpdated

void personalMessageUpdated(java.lang.String robot,
                            java.lang.String user,
                            java.lang.String personalMessage)
                            throws RobotException
Occurs when user changes personal message.

Throws:
RobotException

inkReceived

void inkReceived(RobotSession session,
                 byte[] ink)
                 throws RobotException
Occurs when robot receives ink message .

Parameters:
ink - the data of the received ink message.
Throws:
RobotException

winkReceived

void winkReceived(RobotSession session,
                  RobotResource resource)
                  throws RobotException
Occurs when robot receives wink message.

Parameters:
resource - a descriptor of the received wink message (see RobotResource).
Throws:
RobotException

voiceclipReceived

void voiceclipReceived(RobotSession session,
                       RobotResource resource)
                       throws RobotException
Occurs when robot receives voice clip .

Parameters:
resource - a descriptor of the received voice clip (see RobotResource).
Throws:
RobotException

typingReceived

void typingReceived(RobotSession session)
                    throws RobotException
Occurs user is inputting messages.

Throws:
RobotException

sceneUpdated

void sceneUpdated(java.lang.String robot,
                  java.lang.String user,
                  RobotResource resource)
                  throws RobotException
Occurs when user changes scene.

Parameters:
resource - a descriptor of the received scene (see RobotResource).
Throws:
RobotException

displayPictureUpdated

void displayPictureUpdated(java.lang.String robot,
                           java.lang.String user,
                           RobotResource resource)
                           throws RobotException
Occurs when a user changes display picture .

Parameters:
robot - robot account.
user - user who changes display picture.
resource - a descriptor of the display picture (see RobotResource).
Throws:
RobotException

colorSchemeUpdated

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

contactListReceived

void contactListReceived(java.lang.String robot,
                         java.util.List<RobotUser> contactList)
                         throws RobotException
Occurs when robot receives contact list.

Parameters:
robot - robot account.
contactList - a list contains the account's friend list (see RobotUser).
Throws:
RobotException

resourceReceived

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.