com.zion.jbuddy.bots
Class BotRoute

java.lang.Object
  com.zion.jbuddy.bots.BotRoute

public class BotRoute
extends Object

Routes are used to transfer call processing to clients/users that may not have been involved with the initial command or event. They can be used to forward responses to multiple users, or send responses from another client entirely.

Can be used with targets, menus, and event handlers.

Constructor Summary

BotRoute()
Creates a route.

Method Summary

Object	clone() Returns an exact copy of this route.
String	getRecipients() Returns the list of user names to send responses to.
String	getSender() Returns the id of the client to send responses from.
void	setRecipients(String recipients) Sets the list of user names to send responses to.
void	setSender(String sender) Sets the id of the client to send responses from.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BotRoute

public BotRoute()

Creates a route.

Method Detail

getSender

public String getSender()

Returns the id of the client to send responses from.

setSender

public void setSender(String sender)

Sets the id of the client to send responses from.

If not specified, the default client will be used. The default client is the client that initially received or processed a command or event, unless a route was used that transfered control to another client at some point.

This value can contain content variables.

See Also:

BotClient.setID(java.lang.String)

getRecipients

public String getRecipients()

Returns the list of user names to send responses to.

setRecipients

public void setRecipients(String recipients)

Sets the list of user names to send responses to.

This is a comma-delimited list of user names. If not specified, the default user's name will be used. The default user is the user that initially sent or triggered a command or event, unless a route was used that transfered control to another user at some point.

This value can contain content variables.

clone

public Object clone()

Returns an exact copy of this route.

Overrides:

clone in class Object