Asterisk-Java

org.asteriskjava.fastagi.command
Class GetVariableCommand

java.lang.Object
  extended by org.asteriskjava.fastagi.command.AbstractAgiCommand
      extended by org.asteriskjava.fastagi.command.GetVariableCommand
All Implemented Interfaces:
java.io.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: GetVariableCommand.java 938 2007-12-31 03:23:38Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
GetVariableCommand(java.lang.String variable)
          Creates a new GetVariableCommand.
 
Method Summary
 java.lang.String buildCommand()
          Returns a string suitable to be sent to asterisk.
 java.lang.String getVariable()
          Returns the name of the variable to retrieve.
 void setVariable(java.lang.String variable)
          Sets the name of the variable to retrieve.
 
Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand
escapeAndQuote, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GetVariableCommand

public GetVariableCommand(java.lang.String variable)
Creates a new GetVariableCommand.

Parameters:
variable - the name of the variable to retrieve.
Method Detail

getVariable

public java.lang.String getVariable()
Returns the name of the variable to retrieve.

Returns:
the the name of the variable to retrieve.

setVariable

public void setVariable(java.lang.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 java.lang.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.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.