org.asteriskjava.manager.event

Class ExtensionStatusEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ExtensionStatusEvent

All Implemented Interfaces:

Serializable

public class ExtensionStatusEvent
extends ManagerEvent

An ExtensionStatusEvent is triggered when the state of an extension changes.

For this to work for you must provide appropriate hints in your dialplan to map channels to extensions.
Example:

exten => 1234,1,Dial(SIP/myuser)
 exten => 1234,hint,SIP/myuser

Hints can also be used to map the state of multiple channels to an extension:

exten => 6789,hint,SIP/user1&SIP/user2

It is implemented in manager.c, values for state are defined in include/asterisk/pbx.h.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUSY All devices BUSY.
static int	INUSE One or more devices INUSE.
static int	NOT_INUSE No device INUSE or BUSY.
static int	RINGING One or more devices RINGING.
static int	UNAVAILABLE All devices UNAVAILABLE/UNREGISTERED.

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ExtensionStatusEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getCallerId() Returns the Caller*ID in the form "Some Name" <1234>.
String	getHint() Returns the hint assigned to the extension.
Integer	getStatus() Returns the state of the extension.
String	getStatustext()
void	setCallerId(String callerId) Sets the Caller*ID.
void	setHint(String hint)
void	setStatus(Integer status) Sets the state of the extension.
void	setStatustext(String statustext)

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

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, 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

NOT_INUSE

public static final int NOT_INUSE

No device INUSE or BUSY.

See Also:

Constant Field Values

INUSE

public static final int INUSE

One or more devices INUSE.

See Also:

Constant Field Values

BUSY

public static final int BUSY

All devices BUSY.

See Also:

Constant Field Values

UNAVAILABLE

public static final int UNAVAILABLE

All devices UNAVAILABLE/UNREGISTERED.

See Also:

Constant Field Values

RINGING

public static final int RINGING

One or more devices RINGING.

See Also:

Constant Field Values

Constructor Detail

ExtensionStatusEvent

public ExtensionStatusEvent(Object source)

Method Detail

getHint

public String getHint()

Returns the hint assigned to the extension. The hint is used to map a channel (e.g. "SIP/123") to an extension (e.g. "123").

Available since Asterisk 1.6.

Returns:

the hint (channel name) assigned to the extension.

Since:

1.0.0

setHint

public void setHint(String hint)

getStatus

public Integer getStatus()

Returns the state of the extension.

Possible values are:

• RINGING
• INUSE | RINGING
• INUSE
• NOT_INUSE
• BUSY
• UNAVAILABLE

setStatus

public void setStatus(Integer status)

Sets the state of the extension.

getCallerId

public String getCallerId()

Returns the Caller*ID in the form "Some Name" <1234>.
This property is only available on BRIstuffed Asterisk servers.

Returns:

the Caller*ID.

Since:

0.3

setCallerId

public void setCallerId(String callerId)

Sets the Caller*ID.

Parameters:

callerId - the Caller*ID.

Since:

0.3

getStatustext

public String getStatustext()

setStatustext

public void setStatustext(String statustext)