org.asteriskjava.fastagi.command

Class ChannelStatusCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.ChannelStatusCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class ChannelStatusCommand
extends AbstractAgiCommand

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$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChannelStatusCommand() Creates a new ChannelStatusCommand that queries the current channel.
ChannelStatusCommand(String channel) Creates a new ChannelStatusCommand that queries the given channel.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getChannel() Returns the name of the channel to query.
void	setChannel(String channel) Sets the name of the channel to query.

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

escapeAndQuote, 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(String channel)

Creates a new ChannelStatusCommand that queries the given channel.

Parameters:

channel - the name of the channel to query.

Method Detail

getChannel

public 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(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 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.