org.asteriskjava.manager.event

Class AgentLoginEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.AgentLoginEvent

All Implemented Interfaces:

Serializable

public class AgentLoginEvent
extends ManagerEvent

An AgentLoginEvent is triggered when an agent is successfully logged in using AgentLogin.

It is implemented in channels/chan_agent.c

Version:

$Id$

Author:

srt

See Also:

AgentLogoffEvent, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AgentLoginEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAgent() Returns the name of the agent that logged in.
String	getChannel() Returns the name of the channel associated with the logged in agent.
String	getLoginChan() Deprecated. use getChannel() instead.
String	getUniqueId() Returns the unique id of the channel associated with the logged in agent.
void	setAgent(String agent) Sets the name of the agent that logged in.
void	setChannel(String channel) Sets the name of the channel associated with the logged in agent.
void	setUniqueId(String uniqueId) Sets the unique id of the channel associated with the logged in agent.

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

appendPropertyIfNotNull, getDateReceived, getFile, getFunc, getLine, getPrivilege, getSequenceNumber, getServer, getTimestamp, setDateReceived, setFile, setFunc, setLine, setPrivilege, setSequenceNumber, setServer, 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

Constructor Detail

AgentLoginEvent

public AgentLoginEvent(Object source)

Parameters:

source -

Method Detail

getAgent

public String getAgent()

Returns the name of the agent that logged in.

setAgent

public void setAgent(String agent)

Sets the name of the agent that logged in.

getLoginChan

@Deprecated
public String getLoginChan()

Deprecated. use getChannel() instead.

Returns the name of the channel associated with the logged in agent.

getChannel

public String getChannel()

Returns the name of the channel associated with the logged in agent.

Returns:

the name of the channel associated with the logged in agent.

Since:

0.3

setChannel

public void setChannel(String channel)

Sets the name of the channel associated with the logged in agent.

Parameters:

channel - the name of the channel associated with the logged in agent.

Since:

0.3

getUniqueId

public String getUniqueId()

Returns the unique id of the channel associated with the logged in agent.

Returns:

the unique id of the channel associated with the logged in agent.

setUniqueId

public void setUniqueId(String uniqueId)

Sets the unique id of the channel associated with the logged in agent.

Parameters:

uniqueId - the unique id of the channel associated with the logged in agent.