org.asteriskjava.manager.event.JoinEvent Maven / Gradle / Ivy
Show all versions of asterisk-java Show documentation
/*
* Copyright 2004-2006 Stefan Reuter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.asteriskjava.manager.event;
/**
* A JoinEvent is triggered when a channel joines a queue.
*
* It is implemented in apps/app_queue.c
*
* @author srt
*/
public class JoinEvent extends QueueEvent
{
/**
* Serializable version identifier.
*/
static final long serialVersionUID = 0L;
protected String callerIdName;
protected Integer position;
public JoinEvent(Object source)
{
super(source);
}
/**
* 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.
*
* @return the Caller*ID number of the channel that joined the queue
* @deprecated since 1.0.0, use {@link #getCallerIdNum()} instead.
*/
@Deprecated
public String getCallerId()
{
return callerIdNum;
}
/**
* Sets the Caller*ID number of the channel that joined the queue.
*
* @param callerId the Caller*ID number of the channel that joined the
* queue.
*/
public void setCallerId(String callerId)
{
this.callerIdNum = callerId;
}
/**
* Returns the position of the joined channel in the queue.
*/
public Integer getPosition()
{
return position;
}
/**
* Sets the position of the joined channel in the queue.
*/
public void setPosition(Integer position)
{
this.position = position;
}
}