|
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.HangupAction
public class HangupAction
The HangupAction causes Asterisk to hang up a given channel.
Hangup with a cause code is only supported by Asterisk versions later than 1.6.2.
Constructor Summary | |
---|---|
HangupAction()
Creates a new empty HangupAction. |
|
HangupAction(java.lang.String channel)
Creates a new HangupAction that hangs up the given channel. |
|
HangupAction(java.lang.String channel,
int cause)
Creates a new HangupAction that hangs up the given channel with the given cause code. |
Method Summary | |
---|---|
java.lang.String |
getAction()
Returns the name of this action, i.e. |
java.lang.Integer |
getCause()
Returns the hangup cause. |
java.lang.String |
getChannel()
Returns the name of the channel to hangup. |
void |
setCause(java.lang.Integer cause)
Sets the hangup cause. |
void |
setChannel(java.lang.String channel)
Sets the name of the channel to hangup. |
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 |
Constructor Detail |
---|
public HangupAction()
public HangupAction(java.lang.String channel)
channel
- the name of the channel to hangup.public HangupAction(java.lang.String channel, int cause)
channel
- the name of the channel to hangup.cause
- the cause code. The cause code must be >= 0 and <= 127.Method Detail |
---|
public java.lang.String getAction()
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.String getChannel()
public void setChannel(java.lang.String channel)
This property is mandatory.
channel
- the name of the channel to hangup.public java.lang.Integer getCause()
public void setCause(java.lang.Integer cause)
This property is optional.
cause
- the hangup cause.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |