org.asteriskjava.manager.event

Class StatusEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

org.asteriskjava.manager.event.StatusEvent

All Implemented Interfaces:

Serializable

public class StatusEvent
extends ResponseEvent

A StatusEvent is triggered for each active channel in response to a StatusAction.

Version:

$Id$

Author:

srt

See Also:

StatusAction, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
StatusEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAccount() Deprecated. since 1.0.0, use getAccountCode() instead.
String	getAccountCode() Returns the account code of this channel.
String	getBridgedChannel() Returns the name of the linked channel if this channel is bridged.
String	getBridgedUniqueId() Returns the unique id of the linked channel if this channel is bridged.
String	getCallerId() Deprecated.
String	getCallerIdName() Returns the Caller*ID Name of this channel.
String	getCallerIdNum() Returns the Caller*ID Number of this channel.
String	getChannel() Returns the name of this channel.
Integer	getChannelState() Returns the state of the channel.
String	getChannelStateDesc() Returns the state of the channel as a descriptive text.
String	getContext()
String	getExtension()
String	getLink() Deprecated. as of 1.0.0, use getBridgedChannel() instead.
Integer	getPriority()
Integer	getSeconds() Returns the number of elapsed seconds.
String	getState() Deprecated. use getChannelStateDesc() instead.
String	getUniqueId() Returns the unique id of this channel.
Map<String,String>	getVariables() Returns the channel variables if the StatusAction.setVariables(String) property has been set.
void	setAccount(String account) Sets the account code of this channel.
void	setAccountCode(String accountCode) Sets the account code of this channel.
void	setBridgedChannel(String bridgedChannel) Sets the name of the linked channel.
void	setBridgedUniqueId(String bridgedUniqueId) Sets the unique id of the linked channel if this channel is bridged.
void	setCallerId(String callerIdNum) Sets the Caller*ID Number of this channel.
void	setCallerIdName(String callerIdName) Sets the Caller*ID Name of this channel.
void	setCallerIdNum(String callerIdNum) Sets the Caller*ID Number of this channel.
void	setChannel(String channel) Sets the name of this channel.
void	setChannelState(Integer channelState) Sets the state of the channel.
void	setChannelStateDesc(String channelStateDesc)
void	setContext(String context)
void	setExtension(String extension)
void	setLink(String link) Sets the name of the linked channel.
void	setPriority(Integer priority)
void	setSeconds(Integer seconds) Sets the number of elapsed seconds.
void	setState(String state)
void	setUniqueId(String uniqueId) Sets the unique id of this channel.
void	setVariables(Map<String,String> variables) Sets the channel variables.

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

getActionId, getInternalActionId, setActionId, setInternalActionId

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

StatusEvent

public StatusEvent(Object source)

Method Detail

getChannel

public String getChannel()

Returns the name of this channel.

Returns:

the name of this channel.

setChannel

public void setChannel(String channel)

Sets the name of this channel.

Parameters:

channel - the name of this channel.

getCallerId

@Deprecated
public String getCallerId()

Deprecated.

Returns the Caller*ID Number of this channel.

This property is deprecated as of Asterisk 1.4, use getCallerIdNum() instead.

Returns:

the Caller*ID Number of this channel or null if none is available.

setCallerId

public void setCallerId(String callerIdNum)

Sets the Caller*ID Number of this channel.

This property is deprecated as of Asterisk 1.4.

Parameters:

callerIdNum - the Caller*ID Number to set.

getCallerIdNum

public String getCallerIdNum()

Returns the Caller*ID Number of this channel.

Returns:

the Caller*ID Number of this channel or null if none is available.

Since:

0.3

setCallerIdNum

public void setCallerIdNum(String callerIdNum)

Sets the Caller*ID Number of this channel.

Parameters:

callerIdNum - the Caller*ID Number to set.

Since:

0.3

getCallerIdName

public String getCallerIdName()

Returns the Caller*ID Name of this channel.

Returns:

the Caller*ID Name of this channel or null if none is available.

setCallerIdName

public void setCallerIdName(String callerIdName)

Sets the Caller*ID Name of this channel.

Parameters:

callerIdName - the Caller*ID Name of this channel.

getAccountCode

public String getAccountCode()

Returns the account code of this channel.

Returns:

the account code of this channel.

Since:

1.0.0

setAccountCode

public void setAccountCode(String accountCode)

Sets the account code of this channel.

Parameters:

accountCode - the account code of this channel.

Since:

1.0.0

getAccount

@Deprecated
public String getAccount()

Deprecated. since 1.0.0, use getAccountCode() instead.

Returns the account code of this channel.

Returns:

the account code of this channel.

setAccount

public void setAccount(String account)

Sets the account code of this channel.

Asterisk versions up to 1.4 use the "Account" property instead of "AccountCode".

Parameters:

account - the account code of this channel.

getChannelState

public Integer getChannelState()

Returns the state of the channel.

For Asterisk versions prior to 1.6 (that do not send the numeric value) it is derived from the descriptive text.

Returns:

the state of the channel.

Since:

1.0.0

setChannelState

public void setChannelState(Integer channelState)

Sets the state of the channel.

Parameters:

channelState - the state of the channel.

Since:

1.0.0

getChannelStateDesc

public String getChannelStateDesc()

Returns the state of the channel as a descriptive text.

Returns:

the state of the channel as a descriptive text.

Since:

1.0.0

setChannelStateDesc

public void setChannelStateDesc(String channelStateDesc)

getState

@Deprecated
public String getState()

Deprecated. use getChannelStateDesc() instead.

Returns the state of the channel as a descriptive text.

Returns:

the state of the channel as a descriptive text.

setState

public void setState(String state)

getContext

public String getContext()

setContext

public void setContext(String context)

getExtension

public String getExtension()

setExtension

public void setExtension(String extension)

getPriority

public Integer getPriority()

setPriority

public void setPriority(Integer priority)

getSeconds

public Integer getSeconds()

Returns the number of elapsed seconds.

Returns:

the number of elapsed seconds.

setSeconds

public void setSeconds(Integer seconds)

Sets the number of elapsed seconds.

Parameters:

seconds - the number of elapsed seconds.

getBridgedChannel

public String getBridgedChannel()

Returns the name of the linked channel if this channel is bridged.

Returns:

the name of the linked channel if this channel is bridged.

Since:

1.0.0

setBridgedChannel

public void setBridgedChannel(String bridgedChannel)

Sets the name of the linked channel.

Parameters:

bridgedChannel - the name of the linked channel if this channel is bridged.

Since:

1.0.0

getLink

@Deprecated
public String getLink()

Deprecated. as of 1.0.0, use getBridgedChannel() instead.

Returns the name of the linked channel if this channel is bridged.

Returns:

the name of the linked channel if this channel is bridged.

setLink

public void setLink(String link)

Sets the name of the linked channel.

Asterisk versions up to 1.4 use "Link" instead of "BridgedChannel".

Parameters:

link - the name of the linked channel if this channel is bridged.

getBridgedUniqueId

public String getBridgedUniqueId()

Returns the unique id of the linked channel if this channel is bridged.

Available since Asterisk 1.6.

Returns:

the unique id of the linked channel if this channel is bridged.

Since:

1.0.0

setBridgedUniqueId

public void setBridgedUniqueId(String bridgedUniqueId)

Sets the unique id of the linked channel if this channel is bridged.

Available since Asterisk 1.6.

Parameters:

bridgedUniqueId - the unique id of the linked channel if this channel is bridged.

Since:

1.0.0

getUniqueId

public String getUniqueId()

Returns the unique id of this channel.

Returns:

the unique id of this channel.

setUniqueId

public void setUniqueId(String uniqueId)

Sets the unique id of this channel.

Parameters:

uniqueId - the unique id of this channel.

getVariables

public Map<String,String> getVariables()

Returns the channel variables if the StatusAction.setVariables(String) property has been set.

Available since Asterisk 1.6

Returns:

the channel variables.

Since:

1.0.0

setVariables

public void setVariables(Map<String,String> variables)

Sets the channel variables.

Available since Asterisk 1.6

Parameters:

variables - the channel variables.

Since:

1.0.0