|
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.QueueAddAction
public class QueueAddAction
The QueueAddAction adds a new member to a queue.
It is implemented in apps/app_queue.c
The memberName
property was added in Asterisk 1.4, the
stateInterface
property in Asterisk 1.6.
Constructor Summary | |
---|---|
QueueAddAction()
Creates a new empty QueueAddAction. |
|
QueueAddAction(java.lang.String queue,
java.lang.String iface)
Creates a new QueueAddAction that adds a new member on the given interface to the given queue. |
|
QueueAddAction(java.lang.String queue,
java.lang.String iface,
java.lang.Integer penalty)
Creates a new QueueAddAction that adds a new member on the given interface to the given queue with the given penalty. |
Method Summary | |
---|---|
java.lang.String |
getAction()
Returns the name of this action, i.e. |
java.lang.String |
getInterface()
Returns the name of the channel to dial to reach this member. |
java.lang.String |
getMemberName()
Returns the name of the queue memeber (agent name). |
java.lang.Boolean |
getPaused()
Returns if the queue member should be paused when added. |
java.lang.Integer |
getPenalty()
Returns the penalty for this member. |
java.lang.String |
getQueue()
Returns the name of the queue the new member will be added to. |
java.lang.String |
getStateInterface()
Returns the name of the channel from which to read devicestate changes. |
void |
setInterface(java.lang.String iface)
Sets the name of the channel (Technology/Location) to dial to reach this member. |
void |
setMemberName(java.lang.String memberName)
Sets the name of the queue memeber (agent name). |
void |
setPaused(java.lang.Boolean paused)
Sets if the queue member should be paused when added. |
void |
setPenalty(java.lang.Integer penalty)
Sets the penalty for this member. |
void |
setQueue(java.lang.String queue)
Sets the name of the queue the new member will be added to. |
void |
setStateInterface(java.lang.String stateInterface)
Sets the name of the channel (Technology/Location) from which to read devicestate changes. |
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 QueueAddAction()
public QueueAddAction(java.lang.String queue, java.lang.String iface)
queue
- the name of the queue the new member will be added toiface
- Sets the interface to add. To add a specific channel just
use the channel name, e.g. "SIP/1234".public QueueAddAction(java.lang.String queue, java.lang.String iface, java.lang.Integer penalty)
queue
- the name of the queue the new member will be added toiface
- Sets the interface to add. To add a specific channel just
use the channel name, e.g. "SIP/1234".penalty
- the penalty for this member. The penalty must be a
positive integer or 0 for no penalty. When calls are
distributed members with higher penalties are considered last.Method Detail |
---|
public java.lang.String getAction()
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.String getQueue()
public void setQueue(java.lang.String queue)
This property is mandatory.
queue
- the name of the queue the new member will be added to.public java.lang.String getInterface()
public void setInterface(java.lang.String iface)
This property is mandatory.
iface
- the name of the channel to dial to reach this member, e.g. "SIP/1234".public java.lang.Integer getPenalty()
public void setPenalty(java.lang.Integer penalty)
The penalty must be a positive integer or 0 for no penalty. If it is not set 0 is assumed.
When calls are distributed members with higher penalties are considered last.
penalty
- the penalty for this member.public java.lang.Boolean getPaused()
public void setPaused(java.lang.Boolean paused)
paused
- Boolean.TRUE if the queue member should be paused when
added.public java.lang.String getMemberName()
Available since Asterisk 1.4
public void setMemberName(java.lang.String memberName)
Available since Asterisk 1.4
memberName
- the name of the queue memeber (agent name).public java.lang.String getStateInterface()
Available since Asterisk 1.6
public void setStateInterface(java.lang.String stateInterface)
Available since Asterisk 1.6
stateInterface
- the name of the channel from which to read devicestate changes.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |