com.spectel.bcapi
Interface BridgeListener

public interface BridgeListener

Interface for listener to events from the API

Field Summary

static java.lang.String	CONFERENCE_ID The identifier of the conference object involved in an event.
static java.lang.String	DISC_REASON The disconnect reason of the participant.
static java.lang.String	DTMF_STRING A String object of DTMF keys dialed.
static java.lang.String	DTMF_TIMESTAMP A Long object representing the time that the DTMF keys were dialed.
static java.lang.String	DTMF_TIMESTAMP_USEC A Long object representing the microseconds portion of time that the DTMF keys were dialed.
static java.lang.String	EVENT_TYPE The type of event the received event Hashtable describes.
static java.lang.String	OPER_NAME String identifier of the operator object involved in an event.
static java.lang.String	OPER_NUM Integer identifier of the operator object involved in an event.
static java.lang.String	PARTICIPANT_ID The identifier of the participant object involved in an event.
static java.lang.String	SUB_EVENT_TYPE The sub type of event the received event Hashtable describes.

Method Summary

void	onEvent(java.util.Hashtable eventParameters) Handle an event from the API.

Field Detail

EVENT_TYPE

static final java.lang.String EVENT_TYPE

The type of event the received event Hashtable describes. Values that are valid are CONFERENCE_EVENT, PARTICIPANT_EVENT, INTERNAL_EVENT, TALKER_EVENT, DISCONNECT_EVENT and DTMF_EVENT.

See Also:

Constant Field Values

SUB_EVENT_TYPE

static final java.lang.String SUB_EVENT_TYPE

The sub type of event the received event Hashtable describes. Valid values include STATE_CHANGE, PROPERTY_CHANGE, CONFERENCE_START CONFERENCE_END, QUEUE_CHANGE, PARTICIPANT_ENTER, PARTICIPANT_EXIT, OPER_KNOCK

See Also:

Constant Field Values

PARTICIPANT_ID

static final java.lang.String PARTICIPANT_ID

The identifier of the participant object involved in an event. Event types of TALKER_EVENT, CONFERENCE_EVENT and PARTICIPANT_EVENT may have this value included in the hashtable.

See Also:

Constant Field Values

CONFERENCE_ID

static final java.lang.String CONFERENCE_ID

The identifier of the conference object involved in an event. Event types of TALKER_EVENT, CONFERENCE_EVENT and PARTICIPANT_EVENT may have this value included in the hashtable.

See Also:

Constant Field Values

DISC_REASON

static final java.lang.String DISC_REASON

The disconnect reason of the participant. This is included in PARTICIPANT_EXIT and PARTICIPANT_USER_EXIT events.

See Also:

Constant Field Values

DTMF_STRING

static final java.lang.String DTMF_STRING

A String object of DTMF keys dialed. This is included in a DTMF_EVENT event.

Since:

1.2

See Also:

Constant Field Values

DTMF_TIMESTAMP

static final java.lang.String DTMF_TIMESTAMP

A Long object representing the time that the DTMF keys were dialed. The value represents the number of milliseconds since 00:00:00 UTC, January 1, 1970, with accuracy to a second. This is included in a DTMF_EVENT event.

Since:

1.2

See Also:

Constant Field Values

DTMF_TIMESTAMP_USEC

static final java.lang.String DTMF_TIMESTAMP_USEC

A Long object representing the microseconds portion of time that the DTMF keys were dialed. This is included in a DTMF_EVENT event.

Since:

MX 5.0 BCAPI 1.6

See Also:

Constant Field Values

OPER_NUM

static final java.lang.String OPER_NUM

Integer identifier of the operator object involved in an event. OPER_KNOCK sub-event type events will have this value included in the hashtable.

Since:

1.3

See Also:

Constant Field Values

OPER_NAME

static final java.lang.String OPER_NAME

String identifier of the operator object involved in an event. OPER_KNOCK sub-event type events will have this value included in the hashtable.

Since:

1.3

See Also:

Constant Field Values

Method Detail

onEvent

void onEvent(java.util.Hashtable eventParameters)

Handle an event from the API. Gets a Hashtable containing the details of the event object.

• EVENT_TYPE - Integer - one of CONFERENCE_EVENT, PARTICIPANT_EVENT, INTERNAL_EVENT, TALKER_EVENT, DISCONNECT_EVENT and DTMF_EVENT
• SUB_EVENT_TYPE - Integer - one of STATE_CHANGE, PROPERTY_CHANGE, CONFERENCE_START, CONFERENCE_END, QUEUE_CHANGE, PARTICIPANT_ENTER, PARTICIPANT_EXIT, OPER_KNOCK
• PARTICIPANT_ID - String - Identifies the participant associated with the event.
• CONFERENCE_ID - String - Identifies the conference associated with the event.
• DISC_REASON - Integer - Identifies the reason the participant became disconnected.
• DTMF_STRING - String - Represents the DTMF digits dialed. (DTMF_EVENT only)
• DTMF_TIMESTAMP - Long - The approximate time the DTMF digits were dialed. (DTMF_EVENT only)
• OPER_NAME - String - Identifies the operator associated with the event (OPER_KNOCK only).
• OPER_NUM - Integer - Identifies the operator associated with the event (OPER_KNOCK only).

Parameters:

eventParameters - The event parameters in name value pairs