|
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.AgentLogoffAction
public class AgentLogoffAction
The AgentLogoffAction sets an agent as no longer logged in.
Available since Asterisk 1.2
Constructor Summary | |
---|---|
AgentLogoffAction()
Creates a new empty AgentLogoffAction. |
|
AgentLogoffAction(java.lang.String agent)
Creates a new AgentLogoffAction that logs off the given agent |
|
AgentLogoffAction(java.lang.String agent,
java.lang.Boolean soft)
Creates a new AgentLogoffAction that logs off the given agent |
Method Summary | |
---|---|
java.lang.String |
getAction()
Returns the name of this action, i.e. |
java.lang.String |
getAgent()
Returns the name of the agent to log off, for example "1002". |
java.lang.Boolean |
getSoft()
Returns whether to hangup existing calls or not. |
void |
setAgent(java.lang.String agent)
Sets the name of the agent to log off, for example "1002". |
void |
setSoft(java.lang.Boolean soft)
Sets whether existing calls should be hung up or not. |
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 AgentLogoffAction()
public AgentLogoffAction(java.lang.String agent)
agent
- the name of the agent to log off.public AgentLogoffAction(java.lang.String agent, java.lang.Boolean soft)
agent
- the name of the agent to log off.soft
- Boolean.TRUE if exisiting calls should not be hung up on
logout.Method Detail |
---|
public java.lang.String getAction()
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.String getAgent()
public void setAgent(java.lang.String agent)
This is property is mandatory.
agent
- the name of the agent to log offpublic java.lang.Boolean getSoft()
Default is to hangup existing calls on logoff.
null
if default should be
used.public void setSoft(java.lang.Boolean soft)
Default is to hangup existing calls on logoff.
soft
- Boolean.TRUE if existing calls should not be hung up,
Boolean.FALSE otherwise. null
if default should
be used.
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |