|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.asteriskjava.manager.action.AbstractManagerAction
org.asteriskjava.manager.action.StatusAction
public class StatusAction
The StatusAction requests the state of all active channels. Alternativly (as of Asterisk 1.6) you can also pass a channel name to only retrive the status of one specific channel.
For each active channel a StatusEvent is generated. After the state of all channels has been reported a StatusCompleteEvent is generated.
StatusEvent
,
StatusCompleteEvent
,
Serialized FormConstructor Summary | |
---|---|
StatusAction()
Creates a new StatusAction that retrieves the status of all channels. |
|
StatusAction(java.lang.String channel)
Creates a new StatusAction that retrieves the status of the given channel. |
Method Summary | |
---|---|
java.lang.String |
getAction()
Returns the name of this action, i.e. |
java.lang.Class<? extends ResponseEvent> |
getActionCompleteEventClass()
Returns the event type that indicates that Asterisk is finished sending response events for this action. |
java.lang.String |
getChannel()
Returns the name of the channel. |
java.lang.String |
getVariables()
|
void |
setChannel(java.lang.String channel)
Sets the name of the channel. |
void |
setVariables(java.util.List<java.lang.String> variables)
Sets the names of the channel variables to return for each reported channel. |
void |
setVariables(java.lang.String variables)
Sets the names of the channel variables to return for each reported channel. |
Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction |
---|
getActionId, setActionId, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.asteriskjava.manager.action.ManagerAction |
---|
getActionId, setActionId |
Constructor Detail |
---|
public StatusAction()
public StatusAction(java.lang.String channel)
Available since Asterisk 1.6.
channel
- name of the channel.Method Detail |
---|
public java.lang.String getAction()
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.Class<? extends ResponseEvent> getActionCompleteEventClass()
EventGeneratingAction
getActionCompleteEventClass
in interface EventGeneratingAction
ResponseEvent
public java.lang.String getChannel()
Available since Asterisk 1.6.
null
for all channels.public void setChannel(java.lang.String channel)
Available since Asterisk 1.6.
channel
- the name of the channel or null
for all channels.public java.lang.String getVariables()
public void setVariables(java.lang.String variables)
Available since Asterisk 1.6.
variables
- comma separated list of variables to return for each reported channel.StatusEvent.getVariables()
public void setVariables(java.util.List<java.lang.String> variables)
Available since Asterisk 1.6.
variables
- list of variables to return for each reported channel.StatusEvent.getVariables()
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |