Package com.logicaldoc.robot

Class RobotTool

java.lang.Object

com.logicaldoc.robot.RobotTool

public class RobotTool
extends Object

Utility methods to deal with Robots from within Automation

Since:

9.2

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
RobotTool()

Method Summary

Modifier and Type	Method	Description
String	actionToken(String command, Object... args)	Produces an action token to use in robot's answer.
String	ask(String robotName, String question, RobotHistory transaction)	Asks a question to a robot
String	ask(String robotName, String question, String username)	Asks a question to a robot
String	openDocument(com.logicaldoc.core.document.Document document)	Generates the command token to open a document
String	openDocument(com.logicaldoc.core.folder.Folder folder)	Generates the command token to open a folder

Methods inherited from class java.lang.Object

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

Constructor Details

RobotTool

public RobotTool()

Method Details

ask

public String ask(String robotName,
 String question,
 RobotHistory transaction)

Asks a question to a robot

Parameters:

robotName - Name of the robot to ask

question - The question

transaction - The current session

Returns:

The answer from the robot

ask

public String ask(String robotName,
 String question,
 String username)

Asks a question to a robot

Parameters:

robotName - Name of the robot to ask

question - The question

username - The current user

Returns:

The answer from the robot

actionToken

public String actionToken(String command,
 Object... args)

Produces an action token to use in robot's answer. A command token generates a link that allows the user to take an action in the Robot's chat

Parameters:

command - Mame of the command(eg: OpenDocument)

args - The arguments for the command

Returns:

The command token

openDocument

public String openDocument(com.logicaldoc.core.document.Document document)

Generates the command token to open a document

Parameters:

document - The document to open

Returns:

the

openDocument

public String openDocument(com.logicaldoc.core.folder.Folder folder)

Generates the command token to open a folder

Parameters:

folder - The folder to open

Returns:

the