Asterisk-Java

org.asteriskjava.manager.event
Class JoinEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.QueueEvent
              extended by org.asteriskjava.manager.event.JoinEvent
All Implemented Interfaces:
java.io.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: JoinEvent.java 1296 2009-04-28 10:07:47Z srt $
Author:
srt
See Also:
Serialized Form

Field Summary
protected  java.lang.String callerIdName
           
protected  java.lang.String callerIdNum
           
protected  java.lang.Integer position
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
JoinEvent(java.lang.Object source)
           
 
Method Summary
 java.lang.String getCallerId()
          Deprecated. since 1.0.0, use getCallerIdNum() instead.
 java.lang.String getCallerIdName()
          Returns the Caller*ID name of the channel that joined the queue if set.
 java.lang.String getCallerIdNum()
          Returns the Caller*ID number of the channel that joined the queue if set.
 java.lang.Integer getPosition()
          Returns the position of the joined channel in the queue.
 void setCallerId(java.lang.String callerId)
          Sets the Caller*ID number of the channel that joined the queue.
 void setCallerIdName(java.lang.String callerIdName)
          Sets the Caller*ID name of the channel that joined the queue.
 void setCallerIdNum(java.lang.String callerIdNum)
          Sets the Caller*ID number of the channel that joined the queue.
 void setPosition(java.lang.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
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, 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 java.lang.String callerIdNum

callerIdName

protected java.lang.String callerIdName

position

protected java.lang.Integer position
Constructor Detail

JoinEvent

public JoinEvent(java.lang.Object source)
Method Detail

getCallerId

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.String callerIdName)
Sets the Caller*ID name of the channel that joined the queue.

Since:
0.2

getPosition

public java.lang.Integer getPosition()
Returns the position of the joined channel in the queue.


setPosition

public void setPosition(java.lang.Integer position)
Sets the position of the joined channel in the queue.


Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.