com.zion.jbuddy.bots
Class BotFile

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

All Implemented Interfaces:

BotCall

public class BotFile
extends Object
implements BotCall

Sends a file to a user.

Constructor Summary

BotFile(String path)
Creates a file.

Method Summary

Object	clone() Returns an exact copy of this file.
RichContent	getDescription() Returns this file's description.
String	getPath() Returns this file's path.
String	getRecipients() Returns this file's recipients.
void	setDescription(RichContent description) Sets this file's description.
void	setPath(String path) Sets this file's path.
void	setRecipients(String recipients) Sets this file's recipients.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BotFile

public BotFile(String path)

Creates a file.

Method Detail

getPath

public String getPath()

Returns this file's path.

setPath

public void setPath(String path)

Sets this file's path.

This value can contain content variables.

getDescription

public RichContent getDescription()

Returns this file's description.

setDescription

public void setDescription(RichContent description)

Sets this file's description.

The description is normally sent along with the file transfer invitation to a user.

getRecipients

public String getRecipients()

Returns this file's recipients.

Returns:

the recipients, or null

setRecipients

public void setRecipients(String recipients)

Sets this file's recipients.

This is a comma-delimited list of user names. If no recipients are specified, the file will be sent to the user associated with the event that triggered the file.

This value can contain content variables.

clone

public Object clone()

Returns an exact copy of this file.

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object