com.twilio.ipmessaging

Class TwilioIPMessagingSDK

java.lang.Object

com.twilio.ipmessaging.TwilioIPMessagingSDK

public class TwilioIPMessagingSDK
extends java.lang.Object

Represents an IP Messaging client connection to Twilio. It holds the product-level client context.

Constructor Summary

Constructors

Constructor and Description
TwilioIPMessagingSDK()

Method Summary

Modifier and Type	Method and Description
static TwilioIPMessagingClient	createIPMessagingClientWithAccessManager(TwilioAccessManager accessManager, IPMessagingClientListener listener) Creates a new IP Messaging client instance with a token manager.
static TwilioIPMessagingClient	createIPMessagingClientWithToken(java.lang.String token, IPMessagingClientListener listener) Creates a new IP Messaging client with a token.
static java.lang.String	getVersion() Returns the version of the TwilioIPMessagingSDK.
static void	initializeSDK(android.content.Context inContext, Constants.InitListener inListener) Initialize the TwilioIPMessagingSDK.
static boolean	isInitialized() Determines if the Twilio IP Messaging SDK has been initialized or not.
static void	setLogLevel(int level) Sets the logging level for messages logged by the Twilio IP Messaging SDK.
static void	shutdown() Shuts down the Twilio IP Messaging SDK.

Methods inherited from class java.lang.Object

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

Constructor Detail

TwilioIPMessagingSDK

public TwilioIPMessagingSDK()

Method Detail

isInitialized

public static boolean isInitialized()

Determines if the Twilio IP Messaging SDK has been initialized or not. If you expect your application to run in the background when the user has switched to other applications, you will want to check the return value of this method on startup. The Android OS may have killed your application due to memory pressure, but the SDK may still be running in the background.

Returns:

true if the SDK is currently initialized, false otherwise

initializeSDK

public static void initializeSDK(android.content.Context inContext,
                                 Constants.InitListener inListener)

Initialize the TwilioIPMessagingSDK.

Parameters:

inContext - 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.

inListener - A TwilioIPMessagingSDK.InitListener that will notify you when the service is ready. Cannot be null.

createIPMessagingClientWithToken

public static TwilioIPMessagingClient createIPMessagingClientWithToken(java.lang.String token,
                                                                       IPMessagingClientListener listener)

Creates a new IP Messaging client with a token.

Parameters:

token - The authentication token for the user.

listener - IPMessagingClientListener for this IPMessagingClient.

Returns:

The newly initialized TwilioIPMessagingClient.

createIPMessagingClientWithAccessManager

public static TwilioIPMessagingClient createIPMessagingClientWithAccessManager(TwilioAccessManager accessManager,
                                                                               IPMessagingClientListener listener)

Creates a new IP Messaging client instance with a token manager.

Type Parameters:

TwilioAccessManager -

Parameters:

accessManager - Instance of TwilioAccessManager.

listener - IPMessagingClientListener for this IPMessagingClient.

Returns:

The newly initialized TwilioIPMessagingClient.

shutdown

public static void shutdown()

Shuts down the Twilio IP Messaging SDK. This will terminate all connections, release all TwilioIPMessagingClient objects, and release any resources used by the SDK. Note that any attempt to access existing TwilioIPMessagingClient after calling this method may cause an exception to be thrown, or a crash.

getVersion

public static java.lang.String getVersion()

Returns the version of the TwilioIPMessagingSDK.

Returns:

The version of the SDK.

setLogLevel

public static void setLogLevel(int level)

Sets the logging level for messages logged by the Twilio IP Messaging SDK. Log levels correspond to those specified by Android's Log class. To disable all Twilio SDK logging, set this to Log.ASSERT. The default is Log.ERROR.