|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The LineProcContext interface defines the interface that line processors use to talk to and control the bot core. It provides callback services for message forewarding, as well as utility services.
Method Summary | |
boolean |
bindConversation(String dialogID)
Forces all trafic to and from designated dialog to also be echoed to this LineProc. |
Set |
getComPortBindIDs()
Returns a set of Strings containing the bind IDs of all comports. |
Set |
getConversations()
Fetches the set of all active conversations. |
String |
getIdentity()
Returns the identity of the Dialog object. |
Set |
getLineProcBindIDs()
Returns a set of Strings containing the bind IDs of all line procs. |
String |
getRemoteScreenName()
Returns the foreign screen name attached to this context. |
String |
getWarningLevel()
Fetches the warning level of the account to which this conversation is bound. |
void |
initiateConversation(String commPortBindID,
String remoteScreenName,
String salutation)
Initates a conversation with a remote screen name. |
void |
interject(String dialogID,
String interjection)
Sends an interjection into another Dialog's conversation flow. |
String |
lastLoadedLineProc()
The bind ID of the last loaded class. |
boolean |
loadNewLineProc(String lineProcBindID)
Loads a new line processor and transfers control to it. |
boolean |
loadNewLineProcOnPeer(String dialogID,
String lineProcBindID)
Loads a new line processor for a peer Dialog and transfers control to it. |
void |
sendIM(IM message)
Sends an IM. |
void |
sendWarning(String screenName,
boolean anonymous)
Sends a warning. |
boolean |
unbindConversation(String dialogID)
Halts all traffic to and from designated dialog. |
Method Detail |
public void sendIM(IM message)
message
- The IM to send.public void sendWarning(String screenName, boolean anonymous)
screenName
- The screen name to warn.anonymous
- If TRUE, warn anonymously.public String getWarningLevel()
public String getIdentity()
public String getRemoteScreenName()
public Set getConversations()
public boolean bindConversation(String dialogID)
dialogID
- Dialog ID to bind to in the format
CommPortBindName~ForeignScreenName.public boolean unbindConversation(String dialogID)
dialogID
- Dialog ID to unbind from in the format
CommPortBindName~ForeignScreenName.public boolean loadNewLineProc(String lineProcBindID)
lineProcBindID
- The bind ID of the class to load.
public boolean loadNewLineProcOnPeer(String dialogID, String lineProcBindID)
dialogID
- The peer to manipulate.lineProcBindID
- The line proc to load.
public String lastLoadedLineProc()
public Set getComPortBindIDs()
public Set getLineProcBindIDs()
public void initiateConversation(String commPortBindID, String remoteScreenName, String salutation)
commPortBindID
- The commPort to use for the dialog.remoteScreenName
- The screen name to initiate a conversation with.salutation
- The salutation to send them.public void interject(String dialogID, String interjection)
dialogID
- The name of the dialog to interject into.interjection
- The text to interject with.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |