com.digium.respokesdk

Class RespokeEndpoint

java.lang.Object

com.digium.respokesdk.RespokeEndpoint

public class RespokeEndpoint
extends java.lang.Object

Represents remote Endpoints. Endpoints are users of this application that are not the one logged into this instance of the application. An Endpoint could be logged in from multiple other instances of this app, each of which is represented by a Connection. The client can interact with endpoints by calling them or sending them messages. An endpoint can be a person using an app from a browser or a script using the APIs on a server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RespokeEndpoint.Listener A listener interface to notify the receiver of events occurring with the endpoint

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<RespokeConnection>	connections
java.lang.Object	presence

Constructor Summary

Constructors

Constructor and Description
RespokeEndpoint(RespokeSignalingChannel channel, java.lang.String newEndpointID, RespokeClient client) The constructor for this class

Method Summary

Methods

Modifier and Type	Method and Description
void	didReceiveMessage(java.lang.String message, java.util.Date timestamp) Process a received message.
void	didSendMessage(java.lang.String message, java.util.Date timestamp) Process a sent message.
RespokeDirectConnection	directConnection() Get the active direct connection with this endpoint (if any)
RespokeConnection	getConnection(java.lang.String connectionID, boolean skipCreate) Returns a connection with the specified ID, and optionally creates one if it does not exist
java.util.ArrayList<RespokeConnection>	getConnections() Get an array of connections associated with this endpoint
java.lang.String	getEndpointID() Get the endpoint's ID
void	resolvePresence() Find the presence out of all known connections with the highest priority (most availability) and set it as the endpoint's resolved presence.
void	sendMessage(java.lang.String message, boolean push, boolean ccSelf, Respoke.TaskCompletionListener completionListener) Send a message to the endpoint through the infrastructure.
void	setDirectConnection(RespokeDirectConnection newDirectConnection) Associate a direct connection object with this endpoint.
void	setListener(RespokeEndpoint.Listener listener) Set a receiver for the Listener interface
RespokeCall	startCall(RespokeCall.Listener callListener, android.content.Context context, android.opengl.GLSurfaceView glView, boolean audioOnly) Create a new call with audio and optionally video.
RespokeDirectConnection	startDirectConnection() Create a new DirectConnection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

connections

public java.util.ArrayList<RespokeConnection> connections

presence

public java.lang.Object presence

Constructor Detail

RespokeEndpoint

public RespokeEndpoint(RespokeSignalingChannel channel,
               java.lang.String newEndpointID,
               RespokeClient client)

The constructor for this class

Parameters:

channel - The signaling channel managing communications with this endpoint

newEndpointID - The ID for this endpoint

newClient - The client to which this endpoint instance belongs

Method Detail

setListener

public void setListener(RespokeEndpoint.Listener listener)

Set a receiver for the Listener interface

Parameters:

listener - The new receiver for events from the Listener interface for this endpoint instance

sendMessage

public void sendMessage(java.lang.String message,
               boolean push,
               boolean ccSelf,
               Respoke.TaskCompletionListener completionListener)

Send a message to the endpoint through the infrastructure.

Parameters:

message - The message to send

push - A flag indicating if a push notification should be sent for this message

ccSelf - A flag indicating if the message should be copied to other devices the client might be logged into

completionListener - A listener to receive a notification on the success of the asynchronous operation

startCall

public RespokeCall startCall(RespokeCall.Listener callListener,
                    android.content.Context context,
                    android.opengl.GLSurfaceView glView,
                    boolean audioOnly)

Create a new call with audio and optionally video.

Parameters:

callListener - A listener to receive notifications of call related events

context - An application context with which to access system resources

glView - A GLSurfaceView into which video from the call should be rendered, or null if the call is audio only

audioOnly - Specify true for an audio-only call

Returns:

A new RespokeCall instance

getEndpointID

public java.lang.String getEndpointID()

Get the endpoint's ID

Returns:

The ID

getConnection

public RespokeConnection getConnection(java.lang.String connectionID,
                              boolean skipCreate)

Returns a connection with the specified ID, and optionally creates one if it does not exist

Parameters:

connectionID - The ID of the connection

skipCreate - Whether or not to create a new connection if it is not found

Returns:

The connection that matches the specified ID, or null if not found and skipCreate is true

getConnections

public java.util.ArrayList<RespokeConnection> getConnections()

Get an array of connections associated with this endpoint

Returns:

The array of connections

didReceiveMessage

public void didReceiveMessage(java.lang.String message,
                     java.util.Date timestamp)

Process a received message. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

message - The body of the message

timestamp - The message timestamp

didSendMessage

public void didSendMessage(java.lang.String message,
                  java.util.Date timestamp)

Process a sent message. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

message - The body of the message

timestamp - The message timestamp

resolvePresence

public void resolvePresence()

Find the presence out of all known connections with the highest priority (most availability) and set it as the endpoint's resolved presence.

directConnection

public RespokeDirectConnection directConnection()

Get the active direct connection with this endpoint (if any)

Returns:

The active direct connection instance, or null otherwise

setDirectConnection

public void setDirectConnection(RespokeDirectConnection newDirectConnection)

Associate a direct connection object with this endpoint. This method is used internally by the SDK should not be called by your client application.

Parameters:

newDirectConnection - The direct connection to associate

startDirectConnection

public RespokeDirectConnection startDirectConnection()

Create a new DirectConnection. This method creates a new Call as well, attaching this DirectConnection to it for the purposes of creating a peer-to-peer link for sending data such as messages to the other endpoint. Information sent through a DirectConnection is not handled by the cloud infrastructure.

Returns:

The DirectConnection which can be used to send data and messages directly to the other endpoint.