com.twilio.ipmessaging

Interface TwilioIPMessagingClient

public interface TwilioIPMessagingClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TwilioIPMessagingClient.Properties Properties for client initialization configuration
static class	TwilioIPMessagingClient.SynchronizationStatus Enum representing client initialization status
static class	TwilioIPMessagingClient.SynchronizationStrategy Enum representing client synchronization strategies

Method Summary

Modifier and Type	Method and Description
Channels	getChannels() List of channels available to the TwilioIPMessagingClient.
java.lang.String	getIdentity() Deprecated. As of release 0.5.0, replaced by UserInfo.getIdentity()
IPMessagingClientListener	getListener() Method to retrieve listener for this TwilioIPMessagingClient.
UserInfo	getMyUserInfo() Get user info object for current user
TwilioIPMessagingClient.Properties	getProperties() Get properties for current client
void	handleNotification(java.util.Map<java.lang.String,java.lang.String> notification) Queue the incoming notification with the messaging library for processing.
void	registerGCMToken(java.lang.String token, Constants.StatusListener listener) Register GCM token for push notification updates.
void	setIncomingIntent(android.app.PendingIntent inIntent) Sets a PendingIntent that will be sent when an incoming channel invite is received.
void	setListener(IPMessagingClientListener listener) Method to set listener for this TwilioIPMessagingClient.
void	shutdown() Cleanly shuts down the messaging subsystem when you are done with it.
void	unregisterGCMToken(java.lang.String token, Constants.StatusListener listener) Unregister from push notification updates.
void	updateToken(java.lang.String accessToken, Constants.StatusListener listener) Method to update the authentication token for this client.

Method Detail

getIdentity

@Deprecated
java.lang.String getIdentity()

Deprecated. As of release 0.5.0, replaced by UserInfo.getIdentity()

Returns:

the identity of the user.

getListener

IPMessagingClientListener getListener()

Method to retrieve listener for this TwilioIPMessagingClient.

Returns:

IPMessagingClientListener the listener for this TwilioIPMessagingClient.

setListener

void setListener(IPMessagingClientListener listener)

Method to set listener for this TwilioIPMessagingClient.

Parameters:

listener - the listener for this TwilioIPMessagingClient.

updateToken

void updateToken(java.lang.String accessToken,
                 Constants.StatusListener listener)

Method to update the authentication token for this client.

Parameters:

accessToken - an AccessToken for this Client.

listener - Listener that will receive callback with the result.

getChannels

Channels getChannels()

List of channels available to the TwilioIPMessagingClient.

Returns:

The list of channels for this TwilioIPMessagingClient.

setIncomingIntent

void setIncomingIntent(android.app.PendingIntent inIntent)

Sets a PendingIntent that will be sent when an incoming channel invite is received.

Parameters:

inIntent - intent to send.

registerGCMToken

void registerGCMToken(java.lang.String token,
                      Constants.StatusListener listener)

Register GCM token for push notification updates.

Parameters:

token - The registration token an Android application needs to register with GCM connection servers before it can receive messages.

listener - Listener that will receive callback with the result.

unregisterGCMToken

void unregisterGCMToken(java.lang.String token,
                        Constants.StatusListener listener)

Unregister from push notification updates.

Parameters:

token - The registration token provided for GCM push notification registration.

listener - Listener that will receive callback with the result.

handleNotification

void handleNotification(java.util.Map<java.lang.String,java.lang.String> notification)

Queue the incoming notification with the messaging library for processing. By overriding the method GcmListenerService.onMessageReceived, you can perform actions based on the received message.

Parameters:

notification - Notification received from GCM

getProperties

TwilioIPMessagingClient.Properties getProperties()

Get properties for current client

Returns:

properties for client

shutdown

void shutdown()

Cleanly shuts down the messaging subsystem when you are done with it.

getMyUserInfo

UserInfo getMyUserInfo()

Get user info object for current user

Returns:

User info for current user