com.digium.respokesdk

Interface RespokeSignalingChannel.Listener

All Known Implementing Classes:

RespokeClient

Enclosing class:

RespokeSignalingChannel

public static interface RespokeSignalingChannel.Listener

A delegate protocol to notify the receiver of events occurring with the connection status of the signaling channel

Method Summary

Modifier and Type	Method and Description
void	callCreated(RespokeCall call) Receive a notification from the signaling channel that a call has been created
void	callTerminated(RespokeCall call) Receive a notification from the signaling channel that a call has terminated
RespokeCall	callWithID(java.lang.String sessionID) Find a call with the specified session ID
void	directConnectionAvailable(RespokeDirectConnection directConnection, RespokeEndpoint endpoint) This event is fired when the logged-in endpoint is receiving a request to open a direct connection to another endpoint.
void	onConnect(RespokeSignalingChannel sender, java.lang.String endpointID, java.lang.String connectionID) Receive a notification from the signaling channel that it has connected to the cloud infrastructure
void	onDisconnect(RespokeSignalingChannel sender) Receive a notification from the signaling channel that it has disconnected to the cloud infrastructure
void	onError(java.lang.String errorMessage, RespokeSignalingChannel sender) Receive a notification from the signaling channel that an error has occurred
void	onGroupMessage(java.lang.String message, java.lang.String groupID, java.lang.String endpointID, RespokeSignalingChannel sender, java.util.Date timestamp) Receive a notification that a group message was received
void	onIncomingCall(org.json.JSONObject sdp, java.lang.String sessionID, java.lang.String connectionID, java.lang.String endpointID, java.lang.String fromType, java.util.Date timestamp, RespokeSignalingChannel sender) Receive a notification from the signaling channel that a remote endpoint is attempting to start a call
void	onIncomingDirectConnection(org.json.JSONObject sdp, java.lang.String sessionID, java.lang.String connectionID, java.lang.String endpointID, java.util.Date timestamp, RespokeSignalingChannel sender) Receive a notification from the signaling channel that a remote endpoint is attempting to start a direct connection
void	onJoinGroup(java.lang.String groupID, java.lang.String endpointID, java.lang.String connectionID, RespokeSignalingChannel sender) Receive a notification from the signaling channel that an endpoint has joined this group.
void	onLeaveGroup(java.lang.String groupID, java.lang.String endpointID, java.lang.String connectionID, RespokeSignalingChannel sender) Receive a notification from the signaling channel that an endpoint has left this group.
void	onMessage(java.lang.String message, java.util.Date timestamp, java.lang.String fromEndpointID, java.lang.String toEndpointID, RespokeSignalingChannel sender) Receive a notification from the signaling channel that a message has been sent to this group
void	onPresence(java.lang.Object presence, java.lang.String connectionID, java.lang.String endpointID, RespokeSignalingChannel sender) Receive a notification that a presence change message was received

Method Detail

onConnect

void onConnect(RespokeSignalingChannel sender,
               java.lang.String endpointID,
               java.lang.String connectionID)

Receive a notification from the signaling channel that it has connected to the cloud infrastructure

Parameters:

sender - The signaling channel that triggered the event

endpointID - The endpointID for this connection, as reported by the server

connectionID - The connectionID for this connection.

onDisconnect

void onDisconnect(RespokeSignalingChannel sender)

Receive a notification from the signaling channel that it has disconnected to the cloud infrastructure

Parameters:

sender - The signaling channel that triggered the event

onIncomingCall

void onIncomingCall(org.json.JSONObject sdp,
                    java.lang.String sessionID,
                    java.lang.String connectionID,
                    java.lang.String endpointID,
                    java.lang.String fromType,
                    java.util.Date timestamp,
                    RespokeSignalingChannel sender)

Receive a notification from the signaling channel that a remote endpoint is attempting to start a call

Parameters:

sdp - The SDP data for the call

sessionID - The session ID of the call

connectionID - The connectionID that is calling

endpointID - The endpointID that is calling

timestamp - The timestamp when the call was initiated

fromType - Type of the message source.

sender - The signaling channel that triggered the event

onIncomingDirectConnection

void onIncomingDirectConnection(org.json.JSONObject sdp,
                                java.lang.String sessionID,
                                java.lang.String connectionID,
                                java.lang.String endpointID,
                                java.util.Date timestamp,
                                RespokeSignalingChannel sender)

Receive a notification from the signaling channel that a remote endpoint is attempting to start a direct connection

Parameters:

sdp - The SDP data for the directConnection

sessionID - The session ID of the directConnection

connectionID - The connectionID that is calling

endpointID - The endpointID that is calling

timestamp - The timestamp when the call was initiated

sender - The signaling channel that triggered the event

onError

void onError(java.lang.String errorMessage,
             RespokeSignalingChannel sender)

Receive a notification from the signaling channel that an error has occurred

Parameters:

errorMessage - Error message

sender - The signaling channel that triggered the event

onJoinGroup

void onJoinGroup(java.lang.String groupID,
                 java.lang.String endpointID,
                 java.lang.String connectionID,
                 RespokeSignalingChannel sender)

Receive a notification from the signaling channel that an endpoint has joined this group.

Parameters:

groupID - The ID of the group triggering the join message

endpointID - The ID of the endpoint that to which the connection belongs

connectionID - The ID of the connection that has joined the group

sender - The signaling channel that triggered the event

onLeaveGroup

void onLeaveGroup(java.lang.String groupID,
                  java.lang.String endpointID,
                  java.lang.String connectionID,
                  RespokeSignalingChannel sender)

Receive a notification from the signaling channel that an endpoint has left this group.

Parameters:

groupID - The ID of the group triggering the leave message

endpointID - The ID of the endpoint that to which the connection belongs

connectionID - The ID of the connection that has left the group

sender - The signaling channel that triggered the event

onMessage

void onMessage(java.lang.String message,
               java.util.Date timestamp,
               java.lang.String fromEndpointID,
               java.lang.String toEndpointID,
               RespokeSignalingChannel sender)

Receive a notification from the signaling channel that a message has been sent to this group

Parameters:

message - The body of the message

timestamp - The timestamp of the message

fromEndpointID - The ID of the endpoint sending the message

toEndpointID - The ID of the original recipient of the message if being cc'd to self, otherwise null

sender - The signaling channel that triggered the event

onGroupMessage

void onGroupMessage(java.lang.String message,
                    java.lang.String groupID,
                    java.lang.String endpointID,
                    RespokeSignalingChannel sender,
                    java.util.Date timestamp)

Receive a notification that a group message was received

Parameters:

message - The body of the message

groupID - The ID of the group to which the message was sent

endpointID - The ID of the endpoint that sent the message

sender - The signaling channel that triggered the event

timestamp - The time at which the message was sent

onPresence

void onPresence(java.lang.Object presence,
                java.lang.String connectionID,
                java.lang.String endpointID,
                RespokeSignalingChannel sender)

Receive a notification that a presence change message was received

Parameters:

presence - The new presence value

connectionID - The connection ID whose presence changed

endpointID - The endpoint ID to which the connection belongs

sender - The signaling channel that triggered the event

callCreated

void callCreated(RespokeCall call)

Receive a notification from the signaling channel that a call has been created

Parameters:

call - The RespokeCall instance that was created

callTerminated

void callTerminated(RespokeCall call)

Receive a notification from the signaling channel that a call has terminated

Parameters:

call - The RespokeCall instance that was terminated

callWithID

RespokeCall callWithID(java.lang.String sessionID)

Find a call with the specified session ID

Parameters:

sessionID - SessionID to find

Returns:

The RespokeCall instance with that sessionID. If not found, will return nil.

directConnectionAvailable

void directConnectionAvailable(RespokeDirectConnection directConnection,
                               RespokeEndpoint endpoint)

This event is fired when the logged-in endpoint is receiving a request to open a direct connection to another endpoint. If the user wishes to allow the direct connection, calling 'accept' on the direct connection will allow the connection to be set up.

Parameters:

directConnection - The direct connection object

endpoint - The remote endpoint