org.asteriskjava.manager.event

Class AbstractChannelStateEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.AbstractChannelEvent

org.asteriskjava.manager.event.AbstractChannelStateEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NewChannelEvent, NewStateEvent

public abstract class AbstractChannelStateEvent
extends AbstractChannelEvent

Abstract base class providing common properties for HangupEvent, NewChannelEvent and NewStateEvent.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChannelStateEvent(Object source)

Method Summary

Modifier and Type	Method and Description
Integer	getChannelState() Returns the new state of the channel.
String	getChannelStateDesc() Returns the new state of the channel as a descriptive text.
String	getConnectedlinename()
String	getConnectedlinenum()
String	getState() Deprecated. as of 1.0.0, use getChannelStateDesc() instead or even better switch to numeric values as returned by getChannelState().
void	setChannelState(Integer channelState) Sets the new state of the channel.
void	setChannelStateDesc(String channelStateDesc) Sets the new state of the channel as a descriptive text.
void	setConnectedlinename(String connectedlinename)
void	setConnectedlinenum(String connectedlinenum)
void	setState(String state) Sets the new state of the channel as a descriptive text.

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

getCallerId, getCallerIdName, getCallerIdNum, getChannel, getUniqueId, setCallerId, setCallerIdName, setCallerIdNum, setChannel, 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

Constructor Detail

AbstractChannelStateEvent

protected AbstractChannelStateEvent(Object source)

Method Detail

getConnectedlinename

public String getConnectedlinename()

setConnectedlinename

public void setConnectedlinename(String connectedlinename)

getConnectedlinenum

public String getConnectedlinenum()

setConnectedlinenum

public void setConnectedlinenum(String connectedlinenum)

getChannelState

public Integer getChannelState()

Returns the new 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 new state of the channel.

Since:

1.0.0

setChannelState

public void setChannelState(Integer channelState)

Sets the new state of the channel.

Parameters:

channelState - the new state of the channel.

Since:

1.0.0

getChannelStateDesc

public String getChannelStateDesc()

Returns the new state of the channel as a descriptive text.

The following states are used:

• Down
• Rsrvd
• OffHook
• Dialing
• Ring
• Ringing
• Up
• Busy
• Dialing Offhook (since Asterik 1.6)
• Pre-ring (since Asterik 1.6)

Returns:

the new state of the channel as a descriptive text.

Since:

1.0.0

setChannelStateDesc

public void setChannelStateDesc(String channelStateDesc)

Sets the new state of the channel as a descriptive text.

Parameters:

channelStateDesc - the new state of the channel as a descriptive text.

Since:

1.0.0

getState

@Deprecated
public String getState()

Deprecated. as of 1.0.0, use getChannelStateDesc() instead or even better switch to numeric values as returned by getChannelState().

Returns the new state of the channel as a descriptive text.
This is an alias for getChannelStateDesc().

Returns:

the new state of the channel as a descriptive text.

setState

public void setState(String state)

Sets the new state of the channel as a descriptive text.

The state property is used by Asterisk versions prior to 1.6.

Parameters:

state - the new state of the channel as a descriptive text.