javax.telephony.phone.events
Interface HookswitchStateEv

All Superinterfaces:

Ev, PhoneEv, PhoneTermEv, TermEv

public interface HookswitchStateEv

extends PhoneTermEv

The HookswitchStateEv interface extends the PhoneTermEv interface and is reported via the PhoneTermObserver interface. This event interface indicates that the state of the hookswitch component has changed.

Avaya is providing its backward-compatible Observer model implementation in this release; in the specification this interface is deprecated as of JTAPI 1.4, replaced by PhoneTerminalEvent

Applications may obtain the new state of the hookswitch (either on-hook or off-hook) via the getHookSwitchState() method on this interface.

Field Summary

static int

ID Event id

Fields inherited from interface javax.telephony.phone.events.PhoneEv

CAUSE_NORMAL, CAUSE_UNKNOWN

Fields inherited from interface javax.telephony.events.Ev

CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Method Summary

int	getHookSwitchState() Returns the current state of the hookswitch.

Methods inherited from interface javax.telephony.phone.events.PhoneTermEv

getComponent, getComponentGroup

Methods inherited from interface javax.telephony.phone.events.PhoneEv

getPhoneCause

Methods inherited from interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

Methods inherited from interface javax.telephony.events.TermEv

getTerminal

Field Detail

ID

public static final int ID

Event id

See Also:

Constant Field Values

Method Detail

getHookSwitchState

public int getHookSwitchState()

Returns the current state of the hookswitch.

Returns:

The current state of the hookswitch.