Public Member Functions

BotPlatformSDKLib::_IRobotServerEvents Interface Reference

_IRobotServerEvents Dispatch Interface More...

import "BotPlatformSDK.idl";

List of all members.

Public Member Functions

HRESULT SessionOpened ([in] IRobotSession *session)
HRESULT SessionClosed ([in] IRobotSession *session)
HRESULT MessageReceived ([in] IRobotSession *session,[in] IRobotMessage *message)
HRESULT NudgeReceived ([in] IRobotSession *session)
HRESULT ActivityAccepted ([in] IRobotSession *session)
HRESULT ActivityRejected ([in] IRobotSession *session)
HRESULT ActivityReceived ([in] IRobotSession *session,[in] BSTR data)
HRESULT ActivityLoaded ([in] IRobotSession *session)
HRESULT ActivityClosed ([in] IRobotSession *session)
HRESULT UserJoined ([in] IRobotSession *session,[in] IRobotUser *user)
HRESULT UserLeft ([in] IRobotSession *session,[in] IRobotUser *user)
HRESULT UserAdd ([in] BSTR strRobot,[in] BSTR user)
HRESULT UserRemove ([in] BSTR strRobot,[in] BSTR user)
HRESULT ExceptionCaught ([in] IRobotSession *session,[in] LONG cause)
HRESULT FileAccepted ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT FileRejected ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT FileTransferEnded ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT FileTransferCancelled ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT FileTransferError ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT FileReceived ([in] BSTR robot,[in] BSTR user,[in] IRobotFileDescriptor *fileDescriptor,[in] BSTR saveUrl)
HRESULT FileInvited ([in] IRobotSession *session,[in] IRobotFileDescriptor *fileDescriptor)
HRESULT WebcamAccepted ([in] IRobotSession *session)
HRESULT WebcamRejected ([in] IRobotSession *session)
HRESULT WebcamClosed ([in] IRobotSession *session)
HRESULT WebcamError ([in] IRobotSession *session)
HRESULT UserUpdated ([in] BSTR strRobot,[in] IRobotUser *user)
HRESULT PersonalMessageUpdated ([in] BSTR strRobot,[in] BSTR user,[in] BSTR personalMessage)
HRESULT ContactListReceived ([in] BSTR strRobot,[in] IRobotUsers *contactList)
HRESULT ResourceReceived ([in] BSTR robot,[in] BSTR user,[in] IRobotResource *resource,[in] BSTR saveUrl)
HRESULT InkReceived ([in] IRobotSession *session,[in] BSTR ink)
HRESULT WinkReceived ([in] IRobotSession *session,[in] IRobotResource *resource)
HRESULT VoiceclipReceived ([in] IRobotSession *session,[in] IRobotResource *resource)
HRESULT TypingReceived ([in] IRobotSession *session)
HRESULT SceneUpdated ([in] BSTR strRobot,[in] BSTR user,[in] IRobotResource *resource)
HRESULT DisplayPictureUpdated ([in] BSTR strRobot,[in] BSTR user,[in] IRobotResource *resource)
HRESULT ColorSchemeUpdated ([in] BSTR strRobot,[in] BSTR user,[in] LONG colorScheme)

Detailed Description

_IRobotServerEvents Dispatch Interface


Member Function Documentation

HRESULT BotPlatformSDKLib::_IRobotServerEvents::ActivityAccepted ( [in] IRobotSession session  ) 

Occurs when user accepts an activity (P4) invitation

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ActivityClosed ( [in] IRobotSession session  ) 

Occurs when the activity associated with this session is closed.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ActivityLoaded ( [in] IRobotSession session  ) 

Occurs when the activity associated with this session loaded.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ActivityReceived ( [in] IRobotSession session,
[in] BSTR  data 
)

Occurs when robot receives a user's activity-data( ms activity sdk -> Channel.SendData(...) )

Parameters:
[in] session session
[in] data data
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ActivityRejected ( [in] IRobotSession session  ) 

Occurs when user rejects an activity (P4) invitation

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ColorSchemeUpdated ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] LONG  colorScheme 
)

Occurs when a user changes color scheme.

Parameters:
[in] strRobot robot account
[in] user user who changes color scheme
[in] colorScheme color
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ContactListReceived ( [in] BSTR  strRobot,
[in] IRobotUsers contactList 
)

Occurs when robot receives contact list.

Parameters:
[in] strRobot robot
[in] contactList contact list
HRESULT BotPlatformSDKLib::_IRobotServerEvents::DisplayPictureUpdated ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] IRobotResource resource 
)

Occurs when a user changes display picture.

Parameters:
[in] strRobot robot account
[in] user user who changes display picture
[in] resource a descriptor of the received wink message (see RobotResource).
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ExceptionCaught ( [in] IRobotSession session,
[in] LONG  cause 
)

Occurs when BOTPLATFORM server throws an exception associated with this session

Parameters:
[in] session session
[in] cause cause
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileAccepted ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when user accepts a file transfer invitation.

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileInvited ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when a file invite request is received

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileReceived ( [in] BSTR  robot,
[in] BSTR  user,
[in] IRobotFileDescriptor fileDescriptor,
[in] BSTR  saveUrl 
)

Occurs when a file has been saved to the saveUrl.

Parameters:
[in] robot robot
[in] user user
[in] fileDescriptor file descriptor
[in] saveUrl a url to receive a HTTP POST request to get the data of the file
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileRejected ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when user rejects a file transfer invitation.

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileTransferCancelled ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when a file transfer cancelled.

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileTransferEnded ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when a file transfer ended.

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::FileTransferError ( [in] IRobotSession session,
[in] IRobotFileDescriptor fileDescriptor 
)

Occurs when a file transfer encounters an error.

Parameters:
[in] session session
[in] fileDescriptor file descriptor
HRESULT BotPlatformSDKLib::_IRobotServerEvents::InkReceived ( [in] IRobotSession session,
[in] BSTR  ink 
)

Occurs when robot receives ink message.

Parameters:
[in] session session
[in] ink the data of the received ink message
HRESULT BotPlatformSDKLib::_IRobotServerEvents::MessageReceived ( [in] IRobotSession session,
[in] IRobotMessage message 
)

Occurs when robot receives a user's message

Parameters:
[in] session session
[in] message Received message
HRESULT BotPlatformSDKLib::_IRobotServerEvents::NudgeReceived ( [in] IRobotSession session  ) 

Occurs when robot receives a user's nudge

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::PersonalMessageUpdated ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] BSTR  personalMessage 
)

Occurs when user changes personal message.

Parameters:
[in] strRobot robot
[in] user user
[in] personalMessage personal message
HRESULT BotPlatformSDKLib::_IRobotServerEvents::ResourceReceived ( [in] BSTR  robot,
[in] BSTR  user,
[in] IRobotResource resource,
[in] BSTR  saveUrl 
)

Occurs when a resource has been saved to the saveUrl.

Parameters:
[in] robot robot
[in] user user
[in] resource resource
[in] saveUrl a url to receive a HTTP POST request to get the data of the file
HRESULT BotPlatformSDKLib::_IRobotServerEvents::SceneUpdated ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] IRobotResource resource 
)

Occurs when user changes scene.

Parameters:
[in] strRobot robot
[in] user user
[in] resource a descriptor of the received wink message (see RobotResource).
HRESULT BotPlatformSDKLib::_IRobotServerEvents::SessionClosed ( [in] IRobotSession session  ) 

Occurs when user leaves a session (session closes), which is caused by a user closes a conversation window or session timeout.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::SessionOpened ( [in] IRobotSession 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.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::TypingReceived ( [in] IRobotSession session  ) 

Occurs user is inputting messages.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::UserAdd ( [in] BSTR  strRobot,
[in] BSTR  user 
)

Occurs when user adds the robot to his friend list.

Parameters:
[in] strRobot robot
[in] user user
HRESULT BotPlatformSDKLib::_IRobotServerEvents::UserJoined ( [in] IRobotSession session,
[in] IRobotUser user 
)

Occurs when the a user joins the current conversation.

Parameters:
[in] session session
[in] user user
HRESULT BotPlatformSDKLib::_IRobotServerEvents::UserLeft ( [in] IRobotSession session,
[in] IRobotUser user 
)

Occurs when the a user leaves the current conversation.

Parameters:
[in] session session
[in] user user
HRESULT BotPlatformSDKLib::_IRobotServerEvents::UserRemove ( [in] BSTR  strRobot,
[in] BSTR  user 
)

Occurs when user removes the robot from his friend list

Parameters:
[in] strRobot robot
[in] user user
HRESULT BotPlatformSDKLib::_IRobotServerEvents::UserUpdated ( [in] BSTR  strRobot,
[in] IRobotUser user 
)

Occurs when user changes nickname or status.

Parameters:
[in] strRobot robot
[in] user user
HRESULT BotPlatformSDKLib::_IRobotServerEvents::VoiceclipReceived ( [in] IRobotSession session,
[in] IRobotResource resource 
)

Occurs when robot receives voice clip.

Parameters:
[in] session session
[in] resource a descriptor of the received wink message (see RobotResource).
HRESULT BotPlatformSDKLib::_IRobotServerEvents::WebcamAccepted ( [in] IRobotSession session  ) 

Occurs when user accepts a webcam invitation.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::WebcamClosed ( [in] IRobotSession session  ) 

Occurs when a webcam closed.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::WebcamError ( [in] IRobotSession session  ) 

Occurs when a webcam error occurred.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::WebcamRejected ( [in] IRobotSession session  ) 

Occurs when user rejects a webcam invitation.

Parameters:
[in] session session
HRESULT BotPlatformSDKLib::_IRobotServerEvents::WinkReceived ( [in] IRobotSession session,
[in] IRobotResource resource 
)

Occurs when robot receives wink message.

Parameters:
[in] session session
[in] resource a descriptor of the received wink message (see RobotResource).

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Properties