|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RobotServer
Robot server can be created by RobotServerFactory. Multiple Robot Servers is recommended, when there are large numbers of users. Robot Servers can run on one or more physical machines.
Method Summary | |
---|---|
void |
addConnectionListener(RobotConnectionListener listener)
Deprecated. Add robot server connection listener |
void |
addUser(java.lang.String robot,
java.lang.String user,
java.lang.String inviteMessage)
Add a user to your bot |
RobotMessage |
createMessage()
Create a message |
void |
createSession(java.lang.String robot,
java.lang.String user)
Create a robot session. |
boolean |
isReconnectedSupport()
check whether reconnection is supported . |
void |
login(java.lang.String spid,
java.lang.String sppwd)
Calling this function, Robot Server will login BOTPLATFORM. |
void |
login(java.lang.String spid,
java.lang.String sppwd,
long timeout)
Calling this function, Robot Server will login BOTPLATFORM. |
void |
logout()
Robot server logout BOTPLATFORM |
void |
pushMessage(java.lang.String robot,
java.lang.String user,
RobotMessage message)
Push message to user. |
void |
removeConnectionistener(RobotConnectionListener listener)
Deprecated. Remove robot server connection listener |
void |
requestContactList(java.lang.String robot)
Get the contact list of the specified robot. |
void |
requestResource(java.lang.String robot,
java.lang.String user,
RobotResource resource,
java.lang.String saveUrl)
Get the resouce, the data of the resource file will be posted to a url specified. |
void |
setColorScheme(int colorScheme)
set all robots' color scheme. |
void |
setColorScheme(java.lang.String robotAccount,
int colorScheme)
set a specified robot's color scheme. |
void |
setDisplayName(java.lang.String displayName)
Set all robots's display name |
void |
setDisplayName(java.lang.String robotAccount,
java.lang.String displayName)
Set display name of a specified robot account. |
void |
setDisplayPicture(java.lang.String displayPicture)
Set all robots' display picture |
void |
setDisplayPicture(java.lang.String robotAccount,
java.lang.String displayPicture)
Set display picture of a specified robot account. |
void |
setDisplayPictureEx(java.lang.String displayPicture,
java.lang.String deluxePicture)
Set all robots' display picture |
void |
setDisplayPictureEx(java.lang.String robotAccount,
java.lang.String displayPicture,
java.lang.String deluxePicture)
Set display picture of a specified robot account. |
void |
setPersonalMessage(java.lang.String personalMessage)
Set all robots' personal message |
void |
setPersonalMessage(java.lang.String robotAccount,
java.lang.String personalMessage)
Set personal message of a specified robot account. |
void |
setReconnectedSupport(boolean b)
Set reconnection support. |
void |
setRobotHandler(RobotHandler handler)
Set robot server event handler |
void |
setScene(java.lang.String scene)
Send all robots' scene. |
void |
setScene(java.lang.String robotAccount,
java.lang.String scene)
set scene of a specified robot. |
Method Detail |
---|
void login(java.lang.String spid, java.lang.String sppwd) throws RobotException
spid
- The unique ID assigned by INCESOFTsppwd
- The password assigned by INCESOFT
RobotException
void login(java.lang.String spid, java.lang.String sppwd, long timeout) throws RobotException
spid
- The unique ID assigned by INCESOFTsppwd
- The password assigned by INCESOFTtimeout
- Login timeout, the unit is millisecond
RobotException
void logout()
void setReconnectedSupport(boolean b)
boolean isReconnectedSupport()
void setRobotHandler(RobotHandler handler)
void addConnectionListener(RobotConnectionListener listener)
void removeConnectionistener(RobotConnectionListener listener)
void setDisplayName(java.lang.String displayName) throws RobotException
displayName
- a preferred name preferred
RobotException
void setDisplayName(java.lang.String robotAccount, java.lang.String displayName) throws RobotException
displayName
- a preferred display namerobotAccount
- specify a robot account to be modified.
RobotException
void setPersonalMessage(java.lang.String personalMessage) throws RobotException
personalMessage
-
RobotException
void setPersonalMessage(java.lang.String robotAccount, java.lang.String personalMessage) throws RobotException
personalMessage
- a preferred personal messagerobotAccount
- specify a robot account to be modified.
RobotException
void setDisplayPicture(java.lang.String displayPicture) throws RobotException
displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
RobotException
void setDisplayPicture(java.lang.String robotAccount, java.lang.String displayPicture) throws RobotException
displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORMrobotAccount
- specify a robot account to be modified.
RobotException
void setDisplayPictureEx(java.lang.String displayPicture, java.lang.String deluxePicture) throws RobotException
displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORMdeluxePicture
- unique name of the ddp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
RobotException
void setDisplayPictureEx(java.lang.String robotAccount, java.lang.String displayPicture, java.lang.String deluxePicture) throws RobotException
robotAccount
- specify a robot account to be modified.displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORMdeluxePicture
- unique name of the ddp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
RobotException
void setScene(java.lang.String scene) throws RobotException
scene
- uri of the scene
RobotException
void setScene(java.lang.String robotAccount, java.lang.String scene) throws RobotException
robotAccount
- specify a robot account to be modifiedscene
- uri of the scene
RobotException
void setColorScheme(int colorScheme) throws RobotException
colorScheme
- a preferred color
RobotException
void setColorScheme(java.lang.String robotAccount, int colorScheme) throws RobotException
robotAccount
- specify a robot account to be modifiedcolorScheme
- a preferred color
RobotException
void createSession(java.lang.String robot, java.lang.String user) throws RobotException
robot
- robot iduser
- user id
RobotException
void pushMessage(java.lang.String robot, java.lang.String user, RobotMessage message) throws RobotException
robot
- robot iduser
- user idmessage
- message
RobotException
void requestContactList(java.lang.String robot) throws RobotException
robot
- robot id
RobotException
void requestResource(java.lang.String robot, java.lang.String user, RobotResource resource, java.lang.String saveUrl) throws RobotException
robot
- robot iduser
- user idresource
- the resource to get.saveUrl
- a url receives a HTTP POST request which contains the resource data.
RobotException
RobotMessage createMessage()
RobotMessage
void addUser(java.lang.String robot, java.lang.String user, java.lang.String inviteMessage)
robot
- robot iduser
- user idinviteMessage
- a message shown on the invite panel
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |