|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.incesoft.botplatform.sdk.support.RobotConnection
com.incesoft.botplatform.sdk.support.DefaultRobotServer
public class DefaultRobotServer
Field Summary | |
---|---|
static long |
DEFAULT_LOGIN_TIMEOUT
|
static int |
KEEP_ALIVE_TIMEOUT
|
static java.lang.String |
VERSION
|
Constructor Summary | |
---|---|
DefaultRobotServer()
|
Method Summary | |
---|---|
void |
addConnectionListener(RobotConnectionListener listener)
|
void |
addUser(java.lang.String robot,
java.lang.String user,
java.lang.String inviteMessage)
Add a user to your bot |
void |
assertAlive()
|
RobotMessage |
createMessage()
Create a message |
void |
createSession(java.lang.String robot,
java.lang.String user)
Create a robot session. |
void |
fireServerConnected()
|
void |
fireServerDisconnected()
|
void |
fireServerReconnected()
|
java.lang.String |
getHost()
|
int |
getPort()
|
RobotHandler |
getRobotHandler()
|
java.util.concurrent.ScheduledExecutorService |
getScheduledExecutor()
|
java.lang.String |
getSPID()
|
java.lang.String |
getSPPWD()
|
boolean |
isLoggedIn()
|
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 |
logoutImpl()
|
void |
process_appevent(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String event)
|
void |
process_appmsg(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
AppMessage app)
|
void |
process_colorupdated(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
int colorScheme)
|
void |
process_dpupdated(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ResourceInfo resource)
|
void |
process_error(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ErrorMessage err)
|
void |
process_fileevent(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
FileTransEvent eventObj)
|
void |
process_fileinvite(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
FileTransEvent invitation)
|
void |
process_inkmsg(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String ink)
|
void |
process_join(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
User user)
|
void |
process_loginresp(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
LoginResponse resp)
|
void |
process_msg(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
TextMessage msg)
|
void |
process_nudge(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object obj)
|
void |
process_part(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object obj)
|
void |
process_psmupdated(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String psm)
|
void |
process_redirect(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String[] addrlist)
|
void |
process_resource(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ResourceInfo resource)
|
void |
process_sceneupdated(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ResourceInfo resource)
|
void |
process_sessionclosed(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object obj)
|
void |
process_sessionopened(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
SessionOpenedEvent event)
|
void |
process_typing(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object msgBoby)
|
void |
process_useradded(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object obj)
|
void |
process_userlist(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
User[] userlist)
|
void |
process_userremoved(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.Object obj)
|
void |
process_userremoved(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String psm)
|
void |
process_userupdated(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
RobotUser user)
|
void |
process_voiceclipevent(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ResourceInfo resource)
|
void |
process_webcamevent(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
java.lang.String event)
|
void |
process_winkevent(java.lang.String robotId,
java.lang.String userId,
java.lang.String sessionId,
ResourceInfo resource)
|
void |
pushMessage(java.lang.String robot,
java.lang.String user,
RobotMessage message)
Push message to user. |
void |
removeConnectionistener(RobotConnectionListener 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 robot,
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 |
setHost(java.lang.String host)
|
void |
setLoggedIn(boolean loggedIn)
|
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 |
setPort(int port)
|
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. |
void |
setScheduledExecutor(java.util.concurrent.ScheduledExecutorService scheduledExecutor)
|
void |
setSPID(java.lang.String spid)
|
void |
setSPPWD(java.lang.String sppwd)
|
Methods inherited from class com.incesoft.botplatform.sdk.support.RobotConnection |
---|
close, exceptionCaught, getConnector, getExecutor, keepAlive, messageReceived, messageSent, open, sendMessage, sessionClosed, sessionCreated, sessionIdle, sessionOpened, setConnector, setExecutor |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int KEEP_ALIVE_TIMEOUT
public static final long DEFAULT_LOGIN_TIMEOUT
public static final java.lang.String VERSION
Constructor Detail |
---|
public DefaultRobotServer()
Method Detail |
---|
public void process_loginresp(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, LoginResponse resp) throws java.lang.Exception
java.lang.Exception
public void process_redirect(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String[] addrlist) throws java.lang.Exception
java.lang.Exception
public void process_userupdated(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, RobotUser user) throws java.lang.Exception
java.lang.Exception
public void process_useradded(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
public void process_userremoved(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
public void process_userremoved(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String psm) throws java.lang.Exception
java.lang.Exception
public void process_userlist(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, User[] userlist) throws java.lang.Exception
java.lang.Exception
public void process_sessionopened(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, SessionOpenedEvent event) throws java.lang.Exception
java.lang.Exception
public void process_sessionclosed(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
public void process_join(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, User user) throws java.lang.Exception
java.lang.Exception
public void process_part(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
public void process_msg(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, TextMessage msg) throws java.lang.Exception
java.lang.Exception
public void process_nudge(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
public void process_appmsg(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, AppMessage app) throws java.lang.Exception
java.lang.Exception
public void process_appevent(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String event) throws java.lang.Exception
java.lang.Exception
public void process_fileevent(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, FileTransEvent eventObj) throws java.lang.Exception
java.lang.Exception
public void process_fileinvite(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, FileTransEvent invitation) throws RobotException
RobotException
public void process_webcamevent(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String event) throws java.lang.Exception
java.lang.Exception
public void process_error(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ErrorMessage err) throws java.lang.Exception
java.lang.Exception
public void process_typing(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.Object msgBoby) throws RobotException
RobotException
public void process_voiceclipevent(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ResourceInfo resource) throws RobotException
RobotException
public void process_winkevent(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ResourceInfo resource) throws RobotException
RobotException
public void process_inkmsg(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String ink) throws RobotException
RobotException
public void process_dpupdated(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ResourceInfo resource) throws RobotException
RobotException
public void process_sceneupdated(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ResourceInfo resource) throws RobotException
RobotException
public void process_colorupdated(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, int colorScheme) throws RobotException
RobotException
public void process_psmupdated(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, java.lang.String psm) throws RobotException
RobotException
public void process_resource(java.lang.String robotId, java.lang.String userId, java.lang.String sessionId, ResourceInfo resource)
public void login(java.lang.String spid, java.lang.String sppwd) throws RobotException
RobotServer
login
in interface RobotServer
spid
- The unique ID assigned by INCESOFTsppwd
- The password assigned by INCESOFT
RobotException
public void login(java.lang.String spid, java.lang.String sppwd, long timeout) throws RobotException
RobotServer
login
in interface RobotServer
spid
- The unique ID assigned by INCESOFTsppwd
- The password assigned by INCESOFTtimeout
- Login timeout, the unit is millisecond
RobotException
public void logout()
RobotServer
logout
in interface RobotServer
public void logoutImpl()
public void assertAlive()
public void setDisplayName(java.lang.String displayName) throws RobotException
RobotServer
setDisplayName
in interface RobotServer
displayName
- a preferred name preferred
RobotException
public void setDisplayName(java.lang.String robotAccount, java.lang.String displayName) throws RobotException
RobotServer
setDisplayName
in interface RobotServer
robotAccount
- specify a robot account to be modified.displayName
- a preferred display name
RobotException
public void setPersonalMessage(java.lang.String personalMessage) throws RobotException
RobotServer
setPersonalMessage
in interface RobotServer
RobotException
public void setPersonalMessage(java.lang.String robotAccount, java.lang.String personalMessage) throws RobotException
RobotServer
setPersonalMessage
in interface RobotServer
robotAccount
- specify a robot account to be modified.personalMessage
- a preferred personal message
RobotException
public void setDisplayPicture(java.lang.String displayPicture) throws RobotException
RobotServer
setDisplayPicture
in interface RobotServer
displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
RobotException
public void setDisplayPicture(java.lang.String robotAccount, java.lang.String displayPicture) throws RobotException
RobotServer
setDisplayPicture
in interface RobotServer
robotAccount
- specify a robot account to be modified.displayPicture
- unique name of the dp resource pre-uploaded to BOTPLATFORM and verified by BOTPLATFORM
RobotException
public void createSession(java.lang.String robot, java.lang.String user) throws RobotException
RobotServer
createSession
in interface RobotServer
robot
- robot iduser
- user id
RobotException
public void pushMessage(java.lang.String robot, java.lang.String user, RobotMessage message) throws RobotException
RobotServer
pushMessage
in interface RobotServer
robot
- robot iduser
- user idmessage
- message
RobotException
public void requestContactList(java.lang.String robot) throws RobotException
RobotServer
requestContactList
in interface RobotServer
robot
- robot id
RobotException
public void requestResource(java.lang.String robot, java.lang.String user, RobotResource resource, java.lang.String saveUrl) throws RobotException
RobotServer
requestResource
in interface RobotServer
robot
- robot iduser
- user idresource
- the resource to get.saveUrl
- a url receives a HTTP POST request which contains the resource data.
RobotException
public java.lang.String getSPID()
public void setReconnectedSupport(boolean b)
RobotServer
setReconnectedSupport
in interface RobotServer
public boolean isReconnectedSupport()
RobotServer
isReconnectedSupport
in interface RobotServer
public void addConnectionListener(RobotConnectionListener listener)
addConnectionListener
in interface RobotServer
public void removeConnectionistener(RobotConnectionListener listener)
removeConnectionistener
in interface RobotServer
public void fireServerConnected()
public void fireServerReconnected()
public void fireServerDisconnected()
public void setSPID(java.lang.String spid)
public java.lang.String getSPPWD()
public void setSPPWD(java.lang.String sppwd)
public boolean isLoggedIn()
public void setLoggedIn(boolean loggedIn)
public void setRobotHandler(RobotHandler handler)
RobotServer
setRobotHandler
in interface RobotServer
public RobotHandler getRobotHandler()
public java.lang.String getHost()
public void setHost(java.lang.String host)
public int getPort()
public void setPort(int port)
public java.util.concurrent.ScheduledExecutorService getScheduledExecutor()
public void setScheduledExecutor(java.util.concurrent.ScheduledExecutorService scheduledExecutor)
public void setColorScheme(int colorScheme) throws RobotException
RobotServer
setColorScheme
in interface RobotServer
colorScheme
- a preferred color
RobotException
public void setColorScheme(java.lang.String robot, int colorScheme) throws RobotException
RobotServer
setColorScheme
in interface RobotServer
robot
- specify a robot account to be modifiedcolorScheme
- a preferred color
RobotException
public void setScene(java.lang.String scene) throws RobotException
RobotServer
setScene
in interface RobotServer
scene
- uri of the scene
RobotException
public void setScene(java.lang.String robotAccount, java.lang.String scene) throws RobotException
RobotServer
setScene
in interface RobotServer
robotAccount
- specify a robot account to be modifiedscene
- uri of the scene
RobotException
public void setDisplayPictureEx(java.lang.String displayPicture, java.lang.String deluxePicture) throws RobotException
RobotServer
setDisplayPictureEx
in interface RobotServer
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
public void setDisplayPictureEx(java.lang.String robotAccount, java.lang.String displayPicture, java.lang.String deluxePicture) throws RobotException
RobotServer
setDisplayPictureEx
in interface RobotServer
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
public RobotMessage createMessage()
RobotServer
createMessage
in interface RobotServer
RobotMessage
public void addUser(java.lang.String robot, java.lang.String user, java.lang.String inviteMessage)
RobotServer
addUser
in interface RobotServer
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 |