net.sf.asterisk.manager.action
Class AgentCallbackLoginAction

java.lang.Object
  net.sf.asterisk.manager.action.AbstractManagerAction
      net.sf.asterisk.manager.action.AgentCallbackLoginAction

All Implemented Interfaces:

java.io.Serializable, ManagerAction

public class AgentCallbackLoginAction
extends AbstractManagerAction

The AgentCallbackLoginAction sets an agent as logged in with callback.
You can pass an extentsion (and optionally a context) to specify the destination of the callback.
In contrast to the AgentCallbackLogin application that you can use within Asterisk's dialplan, you don't need to know the agent's password when logging in an agent.
Available since Asterisk 1.2

Since:

0.2

Version:

$Id: AgentCallbackLoginAction.java,v 1.4 2005/08/26 21:56:34 srt Exp $

Author:

srt

See Also:

Serialized Form

Constructor Summary

AgentCallbackLoginAction()
Creates a new empty AgentCallbackLoginAction.

AgentCallbackLoginAction(java.lang.String agent, java.lang.String exten)
Creates a new AgentCallbackLoginAction, that logs in the given agent at the given callback extension.

AgentCallbackLoginAction(java.lang.String agent, java.lang.String exten, java.lang.String context)
Creates a new AgentCallbackLoginAction, that logs in the given agent at the given callback extension in the given context.

Method Summary

java.lang.Boolean	getAckCall() Returns if an acknowledgement is needed when agent is called back.
java.lang.String	getAction() Returns the name of this action, i.e.
java.lang.String	getAgent() Returns the name of the agent to log in, for example "1002".
java.lang.String	getContext() Returns the context of the extension to use for callback.
java.lang.String	getExten() Returns the extension to use for callback.
java.lang.Long	getWrapupTime() Returns the minimum amount of time after disconnecting before the caller can receive a new call.
void	setAckCall(java.lang.Boolean ackCall) Sets if an acknowledgement is needed when agent is called back. This property is optional, it allows you to override the defaults defined in Asterisk's configuration.
void	setAgent(java.lang.String agent) Sets the name of the agent to log in, for example "1002". This is property is mandatory.
void	setContext(java.lang.String context) Sets the context of the extension to use for callback.
void	setExten(java.lang.String exten) Sets the extension to use for callback. This is property is mandatory.
void	setWrapupTime(java.lang.Long wrapupTime) Sets the minimum amount of time after disconnecting before the caller can receive a new call. This property is optional, it allows you to override the defaults defined in Asterisk's configuration.

Methods inherited from class net.sf.asterisk.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

AgentCallbackLoginAction

public AgentCallbackLoginAction()

Creates a new empty AgentCallbackLoginAction.

AgentCallbackLoginAction

public AgentCallbackLoginAction(java.lang.String agent,
                                java.lang.String exten)

Creates a new AgentCallbackLoginAction, that logs in the given agent at the given callback extension.

Parameters:

agent - the name of the agent to log in

exten - the extension that is called to connect a queue member with this agent

AgentCallbackLoginAction

public AgentCallbackLoginAction(java.lang.String agent,
                                java.lang.String exten,
                                java.lang.String context)

Creates a new AgentCallbackLoginAction, that logs in the given agent at the given callback extension in the given context.

Parameters:

agent - the name of the agent to log in

exten - the extension that is called to connect a queue member with this agent

context - the context of the extension to use for callback

Method Detail

getAction

public java.lang.String getAction()

Returns the name of this action, i.e. "AgentCallbackLogin".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

Returns:

the name of this action

getAgent

public java.lang.String getAgent()

Returns the name of the agent to log in, for example "1002".

Returns:

the name of the agent to log in

setAgent

public void setAgent(java.lang.String agent)

Sets the name of the agent to log in, for example "1002".
This is property is mandatory.

Parameters:

agent - the name of the agent to log in

getExten

public java.lang.String getExten()

Returns the extension to use for callback.

Returns:

the extension to use for callback.

setExten

public void setExten(java.lang.String exten)

Sets the extension to use for callback.
This is property is mandatory.

Parameters:

exten - the extension to use for callback.

getContext

public java.lang.String getContext()

Returns the context of the extension to use for callback.

Returns:

the context of the extension to use for callback.

setContext

public void setContext(java.lang.String context)

Sets the context of the extension to use for callback.

Parameters:

context - the context of the extension to use for callback.

getAckCall

public java.lang.Boolean getAckCall()

Returns if an acknowledgement is needed when agent is called back.

Returns:

Boolean.TRUE if acknowledgement by '#' is required when agent is called back, Boolean.FALSE otherwise. null if default should be used.

setAckCall

public void setAckCall(java.lang.Boolean ackCall)

Sets if an acknowledgement is needed when agent is called back.
This property is optional, it allows you to override the defaults defined in Asterisk's configuration.

Parameters:

ackCall - Boolean.TRUE to 'true' to require an acknowledgement by '#' when agent is called back, Boolean.FALSE otherwise. null if default should be used.

getWrapupTime

public java.lang.Long getWrapupTime()

Returns the minimum amount of time after disconnecting before the caller can receive a new call.

Returns:

the minimum amount of time after disconnecting before the caller can receive a new call in milliseconds.

setWrapupTime

public void setWrapupTime(java.lang.Long wrapupTime)

Sets the minimum amount of time after disconnecting before the caller can receive a new call.
This property is optional, it allows you to override the defaults defined in Asterisk's configuration.

Parameters:

wrapupTime - the minimum amount of time after disconnecting before the caller can receive a new call in milliseconds.