|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface AsteriskQueueMember
A queue member. Queue Member can be an agent or a direkt sip account, eg. a Phone.
PropertyChangeEvents are fired for the following properties:
| Field Summary | |
|---|---|
static java.lang.String |
PROPERTY_PAUSED
|
static java.lang.String |
PROPERTY_PENALTY
|
static java.lang.String |
PROPERTY_STATE
|
| Method Summary | |
|---|---|
java.lang.String |
getLocation()
Returns the location of this member. |
java.lang.String |
getMembership()
Returns if this member has been dynamically added by the QueueAdd command (in the dialplan or via the Manager API) or if this member is has been statically defined in queues.conf. |
boolean |
getPaused()
Deprecated. as of 1.0.0. Use isPaused() instead. |
java.lang.Integer |
getPenalty()
Returns the penalty of this member. |
AsteriskQueue |
getQueue()
Returns the queue this member is registerd to. |
QueueMemberState |
getState()
Returns the state of this member. |
boolean |
isDynamic()
Convenience method that checks whether this member has been dynamically added by the QueueAdd command. |
boolean |
isPaused()
Returns whether this member is currently paused.. |
boolean |
isStatic()
Convenience method that checks whether this member has been statically defined in queues.conf. |
void |
setPaused(boolean paused)
Pauses or unpauses this member on this queue. |
void |
setPausedAll(boolean paused)
Pauses or unpauses this member on all queues. |
void |
setPenalty(int penalty)
Assignes a new penalty to this queue member. |
| Methods inherited from interface org.asteriskjava.live.LiveObject |
|---|
addPropertyChangeListener, addPropertyChangeListener, getServer, removePropertyChangeListener, removePropertyChangeListener |
| Field Detail |
|---|
static final java.lang.String PROPERTY_STATE
static final java.lang.String PROPERTY_PENALTY
static final java.lang.String PROPERTY_PAUSED
| Method Detail |
|---|
java.lang.String getLocation()
AsteriskQueue getQueue()
QueueMemberState getState()
boolean getPaused()
isPaused() instead.
true is this queue member is paused, false otherwise.boolean isPaused()
true is this queue member is paused, false otherwise.
void setPaused(boolean paused)
throws ManagerCommunicationException,
NoSuchInterfaceException
paused - true to pause this member, false to unpause.
ManagerCommunicationException - if the QueuePauseAction could not be send to Asterisk.
NoSuchInterfaceException - if the interface or the queue do not exist.
void setPausedAll(boolean paused)
throws ManagerCommunicationException,
NoSuchInterfaceException
paused - true to pause this member, false to unpause.
ManagerCommunicationException - if the QueuePauseAction could not be send to Asterisk.
NoSuchInterfaceException - if the interface or the queue do not exist.java.lang.String getMembership()
queues.conf.
boolean isStatic()
queues.conf.
true if this member has been statically defined in
queues.conf, false otherwise.boolean isDynamic()
true if this member has been dynamically added by
the QueueAdd command, false otherwise.java.lang.Integer getPenalty()
void setPenalty(int penalty)
throws java.lang.IllegalArgumentException,
ManagerCommunicationException,
InvalidPenaltyException
Available since Asterisk 1.6.
penalty - the new penalty value, must not be negative.
java.lang.IllegalArgumentException - if the penalty is negative.
ManagerCommunicationException - if the QueuePenaltyAction could not be send to Asterisk.
InvalidPenaltyException - if Asterisk refused to set the new penalty.
|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||