net.sf.asterisk.fastagi.command
Class ChannelStatusCommand

java.lang.Object
  net.sf.asterisk.fastagi.command.AGICommand
      net.sf.asterisk.fastagi.command.ChannelStatusCommand

All Implemented Interfaces:

java.io.Serializable

public class ChannelStatusCommand
extends AGICommand

Returns the status of the specified channel. If no channel name is given the returns the status of the current channel.
Return values:

• 0 Channel is down and available
• 1 Channel is down, but reserved
• 2 Channel is off hook
• 3 Digits (or equivalent) have been dialed
• 4 Line is ringing
• 5 Remote end is ringing
• 6 Line is up
• 7 Line is busy

Version:

$Id: ChannelStatusCommand.java,v 1.2 2005/03/08 16:48:34 srt Exp $

Author:

srt

See Also:

Serialized Form

Constructor Summary

ChannelStatusCommand()
Creates a new ChannelStatusCommand that queries the current channel.

ChannelStatusCommand(java.lang.String channel)
Creates a new ChannelStatusCommand that queries the given channel.

Method Summary

java.lang.String	buildCommand() Returns a string suitable to be sent to asterisk.
java.lang.String	getChannel() Returns the name of the channel to query.
void	setChannel(java.lang.String channel) Sets the name of the channel to query.

Methods inherited from class net.sf.asterisk.fastagi.command.AGICommand

escapeAndQuote, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelStatusCommand

public ChannelStatusCommand()

Creates a new ChannelStatusCommand that queries the current channel.

ChannelStatusCommand

public ChannelStatusCommand(java.lang.String channel)

Creates a new ChannelStatusCommand that queries the given channel.

Parameters:

channel - the name of the channel to query.

Method Detail

getChannel

public java.lang.String getChannel()

Returns the name of the channel to query.

Returns:

the name of the channel to query or null for the current channel.

setChannel

public void setChannel(java.lang.String channel)

Sets the name of the channel to query.

Parameters:

channel - the name of the channel to query or null for the current channel.

buildCommand

public java.lang.String buildCommand()

Description copied from class: AGICommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in class AGICommand

Returns:

a string suitable to be sent to asterisk.