com.twilio.ipmessaging

Class IPMessagingClient

java.lang.Object

com.twilio.ipmessaging.IPMessagingClient

All Implemented Interfaces:

ChannelListener, IPMessagingClientListener

public final class IPMessagingClient
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPMessagingClient.ConnectionState Enum representing underlying twilsock connection state.
static class	IPMessagingClient.Properties Properties for client initialization configuration
static class	IPMessagingClient.SynchronizationStatus Enum representing client initialization status
static class	IPMessagingClient.SynchronizationStrategy Enum representing client synchronization strategies

Method Summary

Modifier and Type	Method and Description
static IPMessagingClient	create(android.content.Context context, AccessManager accessManager, IPMessagingClient.Properties properties, Constants.CallbackListener<IPMessagingClient> listener) Creates a new IP Messaging client instance with a token manager and client properties.
void	dispose()
Channels	getChannels() List of channels available to the IPMessagingClient.
IPMessagingClient.ConnectionState	getConnectionState()
android.content.Context	getContext()
IPMessagingClientListener	getListener() Method to retrieve listener for this Client.
UserInfo	getMyUserInfo() Get user info object for current user
IPMessagingClient.Properties	getProperties() Get properties for current client
static java.lang.String	getSdkVersion() Returns the version of the IP Messaging SDK.
void	handleNotification(java.util.Map<java.lang.String,java.lang.String> notification) Queue the incoming notification with the messaging library for processing.
boolean	isReachabilityEnabled() Get reachability service status.
void	onAttributesChange(java.util.Map<java.lang.String,java.lang.String> updatedAttributes) Called when channel attributes have changed.
void	onChannelAdd(Channel channel) Called when the current user adds a channel to their list of channels.
void	onChannelChange(Channel channel) Called when one the channel of the current user is changed.
void	onChannelDelete(Channel channel) Called when one of the channel of the current user is deleted.
void	onChannelInvite(Channel channel)
void	onChannelSynchronizationChange(Channel channel) This method is simply to conform to IPMessagingClientListener interface
void	onClientSynchronization(IPMessagingClient.SynchronizationStatus state) Called when client synchronization status changes
void	onConnectionStateChange(IPMessagingClient.ConnectionState state) Called when client connnection state has changed.
void	onError(ErrorInfo errorInfo) Called when an errorInfo condition occurs.
void	onMemberChange(Member member) Called when a Member is changed in the channel the current user is subscribed to.
void	onMemberDelete(Member member) Called when a Member is deleted from the channel the current user is subscribed to.
void	onMemberJoin(Member member) Called when a Member is added to the channel the current user is subscribed to.
void	onMessageAdd(Message message) Called when a Message is added to the channel the current user is subscribed to.
void	onMessageChange(Message message) Called when a Message is changed for the channel the current user is subscribed to.
void	onMessageDelete(Message message) Called when a Message is deleted from the channel the current user is subscribed to.
void	onSynchronizationChange(Channel channel) Called when channel synchronization status changed.
void	onToastFailed(ErrorInfo errorInfo) Called when registering for push notifications fails.
void	onToastNotification(java.lang.String channelId, java.lang.String messageId) Called when client receives a GCM notification.
void	onToastSubscribed() Called when you are successfully registered for push notifications.
void	onTypingEnded(Member member) Called when an Member stops typing on a Channel.
void	onTypingStarted(Member member) Called when an Member starts typing on a Channel.
void	onUserInfoChange(UserInfo userInfo) Called when user info is updated for currently loaded users
void	registerGCMToken(java.lang.String token, Constants.StatusListener listener) Register GCM token for push notification updates.
void	removeListener() Method to remove listener for this Client.
void	setIncomingIntent(android.app.PendingIntent intent) Sets a PendingIntent that will be sent when an incoming channel invite is received.
void	setListener(IPMessagingClientListener listener) Method to set listener for this Client.
static void	setLogLevel(int level)
void	shutdown() Cleanly shuts down the messaging client 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.

Methods inherited from class java.lang.Object

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

Method Detail

getSdkVersion

public static java.lang.String getSdkVersion()

Returns the version of the IP Messaging SDK.

Returns:

The version of the SDK.

create

public static IPMessagingClient create(@NonNull
                                       android.content.Context context,
                                       AccessManager accessManager,
                                       IPMessagingClient.Properties properties,
                                       Constants.CallbackListener<IPMessagingClient> listener)

Creates a new IP Messaging client instance with a token manager and client properties. Callback listener is invoked with reference to IPMessagingClient when client initialization is completed.

Parameters:

context - The Application Context from your Android application. Make sure you don't pass an Activity Context. You can retrieve the Application Context by calling getApplicationContext() on your Activity. Cannot be null.

accessManager - AccessManager for IPMessagingClient

properties - Client initialization properties

listener - Callback listener with reference to IPMessagingClient

Returns:

The newly initialized IPMessagingClient.

updateToken

public 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

public Channels getChannels()

List of channels available to the IPMessagingClient.

Returns:

The list of channels for this IPMessagingClient.

setIncomingIntent

public void setIncomingIntent(android.app.PendingIntent intent)

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

Parameters:

intent - intent to send.

registerGCMToken

public 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

public 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

public 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

public IPMessagingClient.Properties getProperties()

Get properties for current client

Returns:

properties for client

shutdown

public void shutdown()

Cleanly shuts down the messaging client when you are done with it. It will dispose() the client after shutdown, so it could not be reused.

getConnectionState

public IPMessagingClient.ConnectionState getConnectionState()

Returns:

Current transport state.

getMyUserInfo

public UserInfo getMyUserInfo()

Get user info object for current user

Returns:

User info for current user

isReachabilityEnabled

public boolean isReachabilityEnabled()

Get reachability service status.

Returns:

true if reachability info is available, false otherwise.

getContext

public android.content.Context getContext()

dispose

public void dispose()

setLogLevel

public static void setLogLevel(int level)

getListener

public IPMessagingClientListener getListener()

Method to retrieve listener for this Client.

Returns:

ClientListener the listener for this Client.

setListener

public void setListener(IPMessagingClientListener listener)

Method to set listener for this Client.

Parameters:

listener - the listener for this Client.

removeListener

public void removeListener()

Method to remove listener for this Client.

onMessageAdd

public void onMessageAdd(Message message)

Description copied from interface: ChannelListener

Called when a Message is added to the channel the current user is subscribed to.

Specified by:

onMessageAdd in interface ChannelListener

Parameters:

message - The message that has been added.

onMessageChange

public void onMessageChange(Message message)

Description copied from interface: ChannelListener

Called when a Message is changed for the channel the current user is subscribed to.

Specified by:

onMessageChange in interface ChannelListener

Parameters:

message - The message that changed.

onMessageDelete

public void onMessageDelete(Message message)

Description copied from interface: ChannelListener

Called when a Message is deleted from the channel the current user is subscribed to.

Specified by:

onMessageDelete in interface ChannelListener

Parameters:

message - The message that got deleted.

onMemberJoin

public void onMemberJoin(Member member)

Description copied from interface: ChannelListener

Called when a Member is added to the channel the current user is subscribed to.

Specified by:

onMemberJoin in interface ChannelListener

Parameters:

member - The member that joined.

onMemberChange

public void onMemberChange(Member member)

Description copied from interface: ChannelListener

Called when a Member is changed in the channel the current user is subscribed to.

Specified by:

onMemberChange in interface ChannelListener

Parameters:

member - The member that changed.

onMemberDelete

public void onMemberDelete(Member member)

Description copied from interface: ChannelListener

Called when a Member is deleted from the channel the current user is subscribed to.

Specified by:

onMemberDelete in interface ChannelListener

Parameters:

member - The member that was deleted.

onUserInfoChange

public void onUserInfoChange(UserInfo userInfo)

Description copied from interface: IPMessagingClientListener

Called when user info is updated for currently loaded users

Specified by:

onUserInfoChange in interface IPMessagingClientListener

Parameters:

userInfo - Callback for this UserInfo.

onError

public void onError(ErrorInfo errorInfo)

Description copied from interface: IPMessagingClientListener

Called when an errorInfo condition occurs.

Specified by:

onError in interface IPMessagingClientListener

Parameters:

errorInfo - ErrorInfo Object containing errorInfo info

onToastNotification

public void onToastNotification(java.lang.String channelId,
                                java.lang.String messageId)

Description copied from interface: IPMessagingClientListener

Called when client receives a GCM notification.

Specified by:

onToastNotification in interface IPMessagingClientListener

Parameters:

channelId - Sid of related channel

messageId - Sid of related message, if applicable, empty string otherwise

onToastSubscribed

public void onToastSubscribed()

Description copied from interface: IPMessagingClientListener

Called when you are successfully registered for push notifications.

Specified by:

onToastSubscribed in interface IPMessagingClientListener

onToastFailed

public void onToastFailed(ErrorInfo errorInfo)

Description copied from interface: IPMessagingClientListener

Called when registering for push notifications fails.

Specified by:

onToastFailed in interface IPMessagingClientListener

Parameters:

errorInfo - An error indicating the failure.

onTypingStarted

public void onTypingStarted(Member member)

Description copied from interface: ChannelListener

Called when an Member starts typing on a Channel.

Specified by:

onTypingStarted in interface ChannelListener

Parameters:

member - The member that started typing.

onTypingEnded

public void onTypingEnded(Member member)

Description copied from interface: ChannelListener

Called when an Member stops typing on a Channel.

Specified by:

onTypingEnded in interface ChannelListener

Parameters:

member - The member that stopped typing.

onChannelAdd

public void onChannelAdd(Channel channel)

Description copied from interface: IPMessagingClientListener

Called when the current user adds a channel to their list of channels.

Specified by:

onChannelAdd in interface IPMessagingClientListener

Parameters:

channel - The channel that got added.

onChannelInvite

public void onChannelInvite(Channel channel)

onChannelChange

public void onChannelChange(Channel channel)

Description copied from interface: IPMessagingClientListener

Called when one the channel of the current user is changed.

Specified by:

onChannelChange in interface IPMessagingClientListener

Parameters:

channel - The channel that changed.

onChannelDelete

public void onChannelDelete(Channel channel)

Description copied from interface: IPMessagingClientListener

Called when one of the channel of the current user is deleted.

Specified by:

onChannelDelete in interface IPMessagingClientListener

Parameters:

channel - The channel that got deleted.

onChannelSynchronizationChange

public void onChannelSynchronizationChange(Channel channel)

This method is simply to conform to IPMessagingClientListener interface

Specified by:

onChannelSynchronizationChange in interface IPMessagingClientListener

Parameters:

channel - Callback for this Channel.

onSynchronizationChange

public void onSynchronizationChange(Channel channel)

Description copied from interface: ChannelListener

Called when channel synchronization status changed.

Specified by:

onSynchronizationChange in interface ChannelListener

Parameters:

channel - Callback for this Channel.

onClientSynchronization

public void onClientSynchronization(IPMessagingClient.SynchronizationStatus state)

Description copied from interface: IPMessagingClientListener

Called when client synchronization status changes

Specified by:

onClientSynchronization in interface IPMessagingClientListener

Parameters:

state - new client synchronization status

onConnectionStateChange

public void onConnectionStateChange(IPMessagingClient.ConnectionState state)

Description copied from interface: IPMessagingClientListener

Called when client connnection state has changed.

Specified by:

onConnectionStateChange in interface IPMessagingClientListener

Parameters:

state - New connection state.

onAttributesChange

public void onAttributesChange(java.util.Map<java.lang.String,java.lang.String> updatedAttributes)

Description copied from interface: ChannelListener

Called when channel attributes have changed.

Specified by:

onAttributesChange in interface ChannelListener

Parameters:

updatedAttributes - updated channel attribute.