IRobotSession Interface.
More...
import "BotPlatformSDK.idl";
List of all members.
Public Member Functions |
HRESULT | CreateMessage ([out, retval] IRobotMessage **message) |
HRESULT | SendText ([in] BSTR message) |
HRESULT | SendIM ([in]IRobotMessage *message) |
HRESULT | SendNudge (void) |
HRESULT | SendActivity ([in] BSTR url,[in] BSTR strFriendlyName) |
HRESULT | SendActivityEx ([in] BSTR appid,[in] BSTR appname,[in] BSTR data) |
HRESULT | SendTyping (void) |
HRESULT | GetUser ([in] BSTR userid,[out, retval] IRobotUser **ppUser) |
HRESULT | Close (void) |
HRESULT | InviteUser ([in] BSTR user) |
HRESULT | SendFile ([in] BSTR uri,[in] BSTR strFriendlyName) |
HRESULT | SendFileAcceptance ([in] BSTR transferId,[in] BSTR saveUrl) |
HRESULT | SendFileRejection ([in] BSTR transferId) |
HRESULT | SendFileCancellation ([in] BSTR transferId) |
HRESULT | SendInk ([in] BSTR inkData) |
HRESULT | SendWink ([in] BSTR uri,[in] BSTR stamp) |
HRESULT | SendVoiceclip ([in] BSTR uri) |
HRESULT | SendWebcam ([in] BSTR serverIP,[in] LONG serverPort,[in] LONG recipientid,[in] LONG sessionid) |
Properties |
VARIANT_BOOL | ActivityOpened [get] |
IRobotUsers | Users [get] |
BSTR | Robot [get] |
LONG | OpenMode [get] |
VARIANT_BOOL | Closed [get] |
Detailed Description
IRobotSession Interface.
Member Function Documentation
HRESULT IRobotSession::Close |
( |
void |
|
) |
|
Close this session.
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::CreateMessage |
( |
[out, retval] IRobotMessage ** |
message |
) |
|
Create a message
- Parameters:
-
[out] | message | A pointer that receives a pointer to a new instance of the IRobotMessage |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::GetUser |
( |
[in] BSTR |
userid, |
|
|
[out, retval] IRobotUser ** |
ppUser | |
|
) |
| | |
Get a user in session
- Parameters:
-
[in] | userid | user id |
[out] | ppUser | user |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::InviteUser |
( |
[in] BSTR |
user |
) |
|
Invite a user into the current conversation.
- Parameters:
-
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendActivity |
( |
[in] BSTR |
url, |
|
|
[in] BSTR |
strFriendlyName | |
|
) |
| | |
Show the content of network resource in MSN Activity window
- Parameters:
-
[in] | url | network resource to be shown (generally are webpages or pictures) |
[in] | strFriendlyName | friendly name which represents the network resource in the activity invitation, can be NULL. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendActivityEx |
( |
[in] BSTR |
appid, |
|
|
[in] BSTR |
appname, |
|
|
[in] BSTR |
data | |
|
) |
| | |
Show the content of network resource in MSN Activity window
- Parameters:
-
[in] | appid | id of the MSN Activity |
[in] | appname | name of the MSN Activity |
[in] | data | network resource to be shown (generally are webpages or pictures) |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendFile |
( |
[in] BSTR |
uri, |
|
|
[in] BSTR |
strFriendlyName | |
|
) |
| | |
Send a file
- Parameters:
-
[in] | uri | unique name of the resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM |
[in] | strFriendlyName | friendly name which represents the file in the file transfer invitation, can be NULL |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendFileAcceptance |
( |
[in] BSTR |
transferId, |
|
|
[in] BSTR |
saveUrl | |
|
) |
| | |
Accept a file transfer request, and a url should be specified for saving the file data.
- Parameters:
-
[in] | transferId | id of the current file transfer. |
[in] | saveUrl | a url to receive a HTTP POST request to get the data of the file. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendFileCancellation |
( |
[in] BSTR |
transferId |
) |
|
Cancel a file transfer.
- Parameters:
-
[in] | transferId | id of the current file transfer. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendFileRejection |
( |
[in] BSTR |
transferId |
) |
|
Reject a file transfer request.
- Parameters:
-
[in] | transferId | id of the current file transfer. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
Send RobotMessage
- Parameters:
-
[in] | message | RobotMessage |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendInk |
( |
[in] BSTR |
inkData |
) |
|
Send a ink message
- Parameters:
-
[in] | inkData | data of the ink message. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendNudge |
( |
void |
|
) |
|
Send nudge
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendText |
( |
[in] BSTR |
message |
) |
|
Send plain text message
- Parameters:
-
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendTyping |
( |
void |
|
) |
|
Send a typing infomation which will be presented on the bottom of the conversation panel
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendVoiceclip |
( |
[in] BSTR |
uri |
) |
|
Send a voice clip
- Parameters:
-
[in] | uri | unique name of the resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendWebcam |
( |
[in] BSTR |
serverIP, |
|
|
[in] LONG |
serverPort, |
|
|
[in] LONG |
recipientid, |
|
|
[in] LONG |
sessionid | |
|
) |
| | |
Send webcam Once the connection is established, the client that connected to the other peer should authenticate himself with sending the message (no header, no nothing) : "recipientid=X&sessionid=Y\r\n\r\n" The other peer should then send (if correctly authenticated) the message "connected\r\n\r\n" The connecting peer should also send "connected\r\n\r\n" From this point the connection is done and The connecting peer is authenticated Subsequently, the server may send the encoded data of the webcam in mimic format
- Parameters:
-
[in] | serverIP | webcam resource server IP address |
[in] | serverPort | webcam resource server port |
[in] | recipientid | the authentication info, should be between 100 and 199 |
[in] | sessionid | the authentication info, should be between 9000 and 9999 |
- Returns:
- Returns S_OK if successful, or an error value otherwise
HRESULT IRobotSession::SendWink |
( |
[in] BSTR |
uri, |
|
|
[in] BSTR |
stamp | |
|
) |
| | |
Send a msn wink
- Parameters:
-
[in] | uri | unique name of the resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM |
[in] | stamp | base64 encoded signature of the file.It is a S/MIME signature of the Base64 encoded hash of the Content. If this parameter is NULL, wink is default. |
- Returns:
- Returns S_OK if successful, or an error value otherwise
Property Documentation
VARIANT_BOOL IRobotSession::ActivityOpened [get] |
Check whether the activity window opened
- Parameters:
-
| ActivityOpened | activity opened |
VARIANT_BOOL IRobotSession::Closed [get] |
Check whether the session is closed. If session is closed, you cannot send any messages.
- Parameters:
-
LONG IRobotSession::OpenMode [get] |
Get the open mode of session
- Parameters:
-
| OpenMode | 0 - Unknown
1 - Indicates that user opens a conversation window
2 - Indicates that session timeout and then reconnects |
- See also:
- BotPlatformSDKLib::_OPEN_MODE
BSTR IRobotSession::Robot [get] |
Get the robot account(MSN Passport) associated with this session
- Parameters:
-
Get a users' collection in session
- Parameters:
-
The documentation for this interface was generated from the following file: