Public Member Functions

IRobotServer Interface Reference

IRobotServer Interface. More...

import "BotPlatformSDK.idl";

List of all members.

Public Member Functions

HRESULT Login ([in] BSTR spid,[in] BSTR sppwd,[in] LONG timeout)
HRESULT Logout (void)
HRESULT SetDisplayName ([in] BSTR robotAccount,[in] BSTR displayName)
HRESULT SetPersonalMessage ([in] BSTR robotAccount,[in] BSTR personalMessage)
HRESULT SetDisplayPicture ([in] BSTR robotAccount,[in] BSTR displayPicture)
HRESULT SetDisplayPictureEx ([in] BSTR robotAccount,[in] BSTR displayPicture,[in] BSTR largePicture)
HRESULT SetScene ([in] BSTR robotAccount,[in] BSTR scene)
HRESULT SetColorScheme ([in] BSTR robotAccount,[in] LONG colorScheme)
HRESULT CreateSession ([in] BSTR strRobot,[in] BSTR user)
HRESULT CreateMessage ([out, retval] IRobotMessage **message)
HRESULT PushMessage ([in] BSTR strRobot,[in] BSTR user,[in] IRobotMessage *message)
HRESULT RequestContactList ([in] BSTR strRobot)
HRESULT RequestResource ([in] BSTR strRobot,[in] BSTR user,[in] IRobotResource *resource,[in] BSTR saveUrl)
HRESULT AddUser ([in] BSTR robot,[in] BSTR user,[in] BSTR inviteMessage)

Detailed Description

IRobotServer Interface.


Member Function Documentation

HRESULT IRobotServer::AddUser ( [in] BSTR  robot,
[in] BSTR  user,
[in] BSTR  inviteMessage 
)

Add user to the specified robot.

Parameters:
[in] strRobot robot id
[in] user user id
[in] inviteMessage the invite message
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::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 IRobotServer::CreateSession ( [in] BSTR  strRobot,
[in] BSTR  user 
)

Create a robot session.

Parameters:
[in] strRobot robot id
[in] user user id
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::Login ( [in] BSTR  spid,
[in] BSTR  sppwd,
[in] LONG  timeout 
)

Calling this function, Robot Server will login BOTPLATFORM. It's a synchronous operation.

Parameters:
[in] spid The unique ID assigned by INCESOFT
[in] sppwd The password assigned by INCESOFT
[in] timeout Login timeout, the unit is millisecond. If the value less than or equal to 0, use default 1 minute
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::Logout ( void   ) 

Robot server logout BOTPLATFORM

Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::PushMessage ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] IRobotMessage message 
)

Push message to user. may be msn offline message,email message, etc.

Parameters:
[in] strRobot robot id
[in] user user id
[in] message message
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::RequestContactList ( [in] BSTR  strRobot  ) 

Get the contact list of the specified robot.

Parameters:
[in] strRobot robot id
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::RequestResource ( [in] BSTR  strRobot,
[in] BSTR  user,
[in] IRobotResource resource,
[in] BSTR  saveUrl 
)

Get the contact list of the specified robot.

Parameters:
[in] strRobot robot id
[in] user user id
[in] resource the resource to get
[in] saveUrl a url receives a HTTP POST request which contains the resource data
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::SetColorScheme ( [in] BSTR  robotAccount,
[in] LONG  colorScheme 
)

Set robot's color scheme

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] colorScheme a preferred color
Returns:
HRESULT IRobotServer::SetDisplayName ( [in] BSTR  robotAccount,
[in] BSTR  displayName 
)

Set robot's display name

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] displayName a preferred display name
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::SetDisplayPicture ( [in] BSTR  robotAccount,
[in] BSTR  displayPicture 
)

Set robot's display picture

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] displayPicture unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::SetDisplayPictureEx ( [in] BSTR  robotAccount,
[in] BSTR  displayPicture,
[in] BSTR  largePicture 
)

Set robot's display picture

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] displayPicture unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
[in] largePicture unique name of the ddp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::SetPersonalMessage ( [in] BSTR  robotAccount,
[in] BSTR  personalMessage 
)

Set robot's personal message

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] personalMessage a preferred personal message
Returns:
Returns S_OK if successful, or an error value otherwise
HRESULT IRobotServer::SetScene ( [in] BSTR  robotAccount,
[in] BSTR  scene 
)

Set robot's scene

Parameters:
[in] robotAccount specify a robot account to be modified, NULL for all robots
[in] scene uri of the scene
Returns:
Returns S_OK if successful, or an error value otherwise

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