org.asteriskjava.manager.event

Class JoinEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.QueueEvent

org.asteriskjava.manager.event.JoinEvent

All Implemented Interfaces:

Serializable

public class JoinEvent
extends QueueEvent

A JoinEvent is triggered when a channel joines a queue.

It is implemented in apps/app_queue.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	callerIdName
protected String	callerIdNum
protected Integer	position

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
JoinEvent(Object source)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCallerId() Deprecated. since 1.0.0, use getCallerIdNum() instead.
String	getCallerIdName() Returns the Caller*ID name of the channel that joined the queue if set.
String	getCallerIdNum() Returns the Caller*ID number of the channel that joined the queue if set.
Integer	getPosition() Returns the position of the joined channel in the queue.
void	setCallerId(String callerId) Sets the Caller*ID number of the channel that joined the queue.
void	setCallerIdName(String callerIdName) Sets the Caller*ID name of the channel that joined the queue.
void	setCallerIdNum(String callerIdNum) Sets the Caller*ID number of the channel that joined the queue.
void	setPosition(Integer position) Sets the position of the joined channel in the queue.

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

getChannel, getCount, getQueue, getUniqueId, setChannel, setCount, setQueue, setUniqueId

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

Field Detail

callerIdNum

protected String callerIdNum

callerIdName

protected String callerIdName

position

protected Integer position

Constructor Detail

JoinEvent

public JoinEvent(Object source)

Method Detail

getCallerId

@Deprecated
public String getCallerId()

Deprecated. since 1.0.0, use getCallerIdNum() instead.

Returns the Caller*ID number of the channel that joined the queue if set. If the channel has no caller id set "unknown" is returned.

Returns:

the Caller*ID number of the channel that joined the queue

setCallerId

public void setCallerId(String callerId)

Sets the Caller*ID number of the channel that joined the queue.

Parameters:

callerId - the Caller*ID number of the channel that joined the queue.

getCallerIdNum

public String getCallerIdNum()

Returns the Caller*ID number of the channel that joined the queue if set. If the channel has no caller id set "unknown" is returned.

Returns:

the Caller*ID number of the channel that joined the queue

Since:

1.0.0

setCallerIdNum

public void setCallerIdNum(String callerIdNum)

Sets the Caller*ID number of the channel that joined the queue.

Parameters:

callerIdNum - the Caller*ID number of the channel that joined the queue.

getCallerIdName

public String getCallerIdName()

Returns the Caller*ID name of the channel that joined the queue if set. If the channel has no caller id set "unknown" is returned.

Since:

0.2

setCallerIdName

public void setCallerIdName(String callerIdName)

Sets the Caller*ID name of the channel that joined the queue.

Since:

0.2

getPosition

public Integer getPosition()

Returns the position of the joined channel in the queue.

setPosition

public void setPosition(Integer position)

Sets the position of the joined channel in the queue.