org.asteriskjava.fastagi.command

Class GetVariableCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.GetVariableCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class GetVariableCommand
extends AbstractAgiCommand

Returns the value of the given channel varible.

Since Asterisk 1.2 you can also use this command to use custom Asterisk functions. Syntax is "func(args)".

Returns 0 if the variable is not set. Returns 1 if the variable is set and returns the variable in parenthesis.

Example return code: 200 result=1 (testvariable)

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetVariableCommand(String variable) Creates a new GetVariableCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getVariable() Returns the name of the variable to retrieve.
void	setVariable(String variable) Sets the name of the variable to retrieve.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GetVariableCommand

public GetVariableCommand(String variable)

Creates a new GetVariableCommand.

Parameters:

variable - the name of the variable to retrieve.

Method Detail

getVariable

public String getVariable()

Returns the name of the variable to retrieve.

Returns:

the the name of the variable to retrieve.

setVariable

public void setVariable(String variable)

Sets the name of the variable to retrieve.

Since Asterisk 1.2 you can also use custom dialplan functions (like "func(args)") as variable.

Parameters:

variable - the name of the variable to retrieve.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.