com.digium.respokesdk

Class RespokeGroup

java.lang.Object

com.digium.respokesdk.RespokeGroup

public class RespokeGroup
extends java.lang.Object

A group, representing a collection of connections and the method by which to communicate with them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RespokeGroup.GetGroupMembersCompletionListener A listener interface to receive a notification that the task to get the list of group members has completed
static interface	RespokeGroup.Listener A listener interface to notify the receiver of events occurring with the group

Constructor Summary

Constructors

Constructor and Description
RespokeGroup(java.lang.String newGroupID, RespokeSignalingChannel channel, RespokeClient newClient) The constructor for this class

Method Summary

Methods

Modifier and Type	Method and Description
void	connectionDidJoin(RespokeConnection connection) Notify the group that a connection has joined.
void	connectionDidLeave(RespokeConnection connection) Notify the group that a connection has left.
void	didReceiveMessage(java.lang.String message, RespokeEndpoint endpoint, java.util.Date timestamp) Notify the group that a group message was received.
java.lang.String	getGroupID() Get the ID for this group
void	getMembers(RespokeGroup.GetGroupMembersCompletionListener completionListener) Get an array containing the members of the group.
boolean	isJoined() Return true if the local client is a member of this group and false if not.
void	leave(Respoke.TaskCompletionListener completionListener) Leave this group
void	sendMessage(java.lang.String message, boolean push, Respoke.TaskCompletionListener completionListener) Send a message to the entire group.
void	setListener(RespokeGroup.Listener listener) Set a receiver for the Listener interface

Methods inherited from class java.lang.Object

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

Constructor Detail

RespokeGroup

public RespokeGroup(java.lang.String newGroupID,
            RespokeSignalingChannel channel,
            RespokeClient newClient)

The constructor for this class

Parameters:

newGroupID - The ID for this group

channel - The signaling channel managing communications with this group

newClient - The client to which this group instance belongs

Method Detail

setListener

public void setListener(RespokeGroup.Listener listener)

Set a receiver for the Listener interface

Parameters:

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

getMembers

public void getMembers(RespokeGroup.GetGroupMembersCompletionListener completionListener)

Get an array containing the members of the group.

Parameters:

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

leave

public void leave(Respoke.TaskCompletionListener completionListener)

Leave this group

Parameters:

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

isJoined

public boolean isJoined()

Return true if the local client is a member of this group and false if not.

Returns:

The membership status

getGroupID

public java.lang.String getGroupID()

Get the ID for this group

Returns:

The group's ID

sendMessage

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

Send a message to the entire group.

Parameters:

message - The message to send

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

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

connectionDidJoin

public void connectionDidJoin(RespokeConnection connection)

Notify the group that a connection has joined. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

connection - The connection that has joined the group

connectionDidLeave

public void connectionDidLeave(RespokeConnection connection)

Notify the group that a connection has left. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

connection - The connection that has left the group

didReceiveMessage

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

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

Parameters:

message - The body of the message

endpoint - The endpoint that sent the message

timestamp - The message timestamp