org.asteriskjava.manager.event

Class AgentsEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

org.asteriskjava.manager.event.AgentsEvent

All Implemented Interfaces:

Serializable

public class AgentsEvent
extends ResponseEvent

An AgentsEvent is triggered for each agent in response to an AgentsAction.

Available since Asterisk 1.2

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

AgentsAction, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_STATUS_IDLE Agent is logged in and waiting for call.
static String	AGENT_STATUS_LOGGEDOFF Agent isn't logged in.
static String	AGENT_STATUS_ONCALL Agent is logged in and on a call.
static String	AGENT_STATUS_UNKNOWN Don't know anything about agent.

Fields inherited from class org.asteriskjava.manager.event.ResponseEvent

actionId

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AgentsEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAgent() Returns the agentid.
String	getLoggedInChan() Returns the name of channel this agent logged in from.
Long	getLoggedInTime() Returns the time (in seconds since 01/01/1970) when the agent logged in.
String	getName() Returns the name of this agent.
String	getStatus() Returns the status of this agent.
String	getTalkingTo() Returns the numerical Caller*ID of the channel this agent is talking to.
String	getTalkingToChan() Returns the name of the channel this agent is talking to.
void	setAgent(String agent) Sets the agentid.
void	setLoggedInChan(String loggedInChan) Sets the name of channel this agent logged in from.
void	setLoggedInTime(Long loggedInTime) Sets the time when the agent logged in.
void	setName(String name) Sets the name of this agent.
void	setStatus(String status) Sets the status of this agent.
void	setTalkingTo(String talkingTo) Sets the numerical Caller*ID of the channel this agent is talking to.
void	setTalkingToChan(String talkingToChan)

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent

getActionId, getInternalActionId, setActionId, setInternalActionId

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, 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

Field Detail

AGENT_STATUS_LOGGEDOFF

public static final String AGENT_STATUS_LOGGEDOFF

Agent isn't logged in.

See Also:

Constant Field Values

AGENT_STATUS_IDLE

public static final String AGENT_STATUS_IDLE

Agent is logged in and waiting for call.

See Also:

Constant Field Values

AGENT_STATUS_ONCALL

public static final String AGENT_STATUS_ONCALL

Agent is logged in and on a call.

See Also:

Constant Field Values

AGENT_STATUS_UNKNOWN

public static final String AGENT_STATUS_UNKNOWN

Don't know anything about agent. Shouldn't ever get this.

See Also:

Constant Field Values

Constructor Detail

AgentsEvent

public AgentsEvent(Object source)

Parameters:

source -

Method Detail

getAgent

public String getAgent()

Returns the agentid.

setAgent

public void setAgent(String agent)

Sets the agentid.

getName

public String getName()

Returns the name of this agent.

Returns:

the name of this agent

setName

public void setName(String name)

Sets the name of this agent.

Parameters:

name - the name of this agent

getStatus

public String getStatus()

Returns the status of this agent.

This is one of

"AGENT_LOGGEDOFF"

Agent isn't logged in

"AGENT_IDLE"

Agent is logged in and waiting for call

"AGENT_ONCALL"

Agent is logged in and on a call

"AGENT_UNKNOWN"

Don't know anything about agent. Shouldn't ever get this.

Returns:

the status of this agent

See Also:

AGENT_STATUS_LOGGEDOFF, AGENT_STATUS_IDLE, AGENT_STATUS_ONCALL, AGENT_STATUS_UNKNOWN

setStatus

public void setStatus(String status)

Sets the status of this agent.

Parameters:

status - the status of this agent

getLoggedInChan

public String getLoggedInChan()

Returns the name of channel this agent logged in from.

Returns:

the name of the channel this agent logged in from or "n/a" if the agent is not logged in.

setLoggedInChan

public void setLoggedInChan(String loggedInChan)

Sets the name of channel this agent logged in from.

Parameters:

loggedInChan - the name of channel this agent logged in from

getLoggedInTime

public Long getLoggedInTime()

Returns the time (in seconds since 01/01/1970) when the agent logged in.

Returns:

the time when the agent logged in or 0 if the user is not logged in.

setLoggedInTime

public void setLoggedInTime(Long loggedInTime)

Sets the time when the agent logged in.

Parameters:

loggedInTime - the time when the agent logged in

getTalkingTo

public String getTalkingTo()

Returns the numerical Caller*ID of the channel this agent is talking to.

Returns:

the numerical Caller*ID of the channel this agent is talking to or "n/a" if this agent is talking to nobody.

setTalkingTo

public void setTalkingTo(String talkingTo)

Sets the numerical Caller*ID of the channel this agent is talking to.

Parameters:

talkingTo - the numerical Caller*ID of the channel this agent is talking to

getTalkingToChan

public String getTalkingToChan()

Returns the name of the channel this agent is talking to.

Available since Asterisk 1.6.

Returns:

the name of the channel this agent is talking to.

Since:

1.0.0

setTalkingToChan

public void setTalkingToChan(String talkingToChan)