|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.asteriskjava.manager.event.ManagerEvent
org.asteriskjava.manager.event.HoldEvent
public class HoldEvent
A HoldEvent is triggered when a channel is put on hold (or no longer on hold).
It is implemented in channels/chan_sip.c
.
Available since Asterisk 1.2 for SIP channels, as of Asterisk 1.6 this event is also supported for IAX2 channels.
To receive HoldEvents for SIP channels you must set callevents = yes
in sip.conf
.
Field Summary |
---|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
HoldEvent(java.lang.Object source)
Creates a new HoldEvent. |
Method Summary | |
---|---|
java.lang.String |
getChannel()
Returns the name of the channel. |
java.lang.Boolean |
getStatus()
Returns whether this is a hold or unhold event. |
java.lang.String |
getUniqueId()
Returns the unique id of the channel. |
boolean |
isHold()
Returns whether this is a hold event. |
boolean |
isUnhold()
Returns whether this is an unhold event. |
void |
setChannel(java.lang.String channel)
Sets the name of the channel. |
void |
setStatus(java.lang.Boolean status)
Returns whether this is a hold or unhold event. |
void |
setUniqueId(java.lang.String uniqueId)
Sets the unique id of the channel. |
Methods inherited from class org.asteriskjava.manager.event.ManagerEvent |
---|
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, setServer, setTimestamp, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HoldEvent(java.lang.Object source)
source
- Method Detail |
---|
public java.lang.String getChannel()
public void setChannel(java.lang.String channel)
channel
- the name of the channel.public java.lang.String getUniqueId()
public void setUniqueId(java.lang.String uniqueId)
uniqueId
- the unique id of the channel.public java.lang.Boolean getStatus()
true
if this a hold event, false
if it's an unhold event.public void setStatus(java.lang.Boolean status)
status
- true
if this a hold event, false
if it's an unhold event.public boolean isHold()
true
if this a hold event, false
if it's an unhold event.public boolean isUnhold()
true
if this an unhold event, false
if it's a hold event.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |