com.digium.respokesdk

Class Respoke

java.lang.Object

com.digium.respokesdk.Respoke

public class Respoke
extends java.lang.Object

A global static class which provides access to the Respoke functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Respoke.TaskCompletionListener A listener interface to allow the receiver to be notified of the success or failure of an asynchronous operation

Field Summary

Fields

Modifier and Type	Field and Description
static int	GUID_STRING_LENGTH

Method Summary

Modifier and Type	Method and Description
void	clientConnected(RespokeClient client) Notify the shared SDK instance that the specified client has connected.
RespokeClient	createClient(android.content.Context appContext) This is one of two possible entry points for interacting with the library.
static java.lang.String	makeGUID() Create a globally unique identifier for naming instances
static void	postTaskError(Respoke.TaskCompletionListener completionListener, java.lang.String errorMessage) A helper function to post an error message to a TaskCompletionListener on the UI thread
static void	postTaskSuccess(Respoke.TaskCompletionListener completionListener) A helper function to post success to a TaskCompletionListener on the UI thread
void	registerPushToken(java.lang.String token) Notify the Respoke SDK that this device should register itself for push notifications
static Respoke	sharedInstance() Retrieve the globally shared instance of the Respoke SDK
void	unregisterClient(RespokeClient client) Unregister a client that is no longer active so that it's resources can be deallocated
void	unregisterPushServices(Respoke.TaskCompletionListener completionListener) Unregister this device from the Respoke push notification service and stop any future notifications until it is re-registered

Methods inherited from class java.lang.Object

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

Field Detail

GUID_STRING_LENGTH

public static final int GUID_STRING_LENGTH

See Also:

Constant Field Values

Method Detail

postTaskSuccess

public static void postTaskSuccess(Respoke.TaskCompletionListener completionListener)

A helper function to post success to a TaskCompletionListener on the UI thread

Parameters:

completionListener - The TaskCompletionListener to notify

postTaskError

public static void postTaskError(Respoke.TaskCompletionListener completionListener,
                                 java.lang.String errorMessage)

A helper function to post an error message to a TaskCompletionListener on the UI thread

Parameters:

completionListener - The TaskCompletionListener to notify

errorMessage - The error message to post

sharedInstance

public static Respoke sharedInstance()

Retrieve the globally shared instance of the Respoke SDK

Returns:

Respoke SDK instance

createClient

public RespokeClient createClient(android.content.Context appContext)

This is one of two possible entry points for interacting with the library. This method creates a new Client object which represents your app's connection to the cloud infrastructure. This method does NOT automatically call the client.connect() method after the client is created, so your app will need to call it when it is ready to connect.

Parameters:

appContext - The Android application Context

Returns:

A Respoke Client instance

unregisterClient

public void unregisterClient(RespokeClient client)

Unregister a client that is no longer active so that it's resources can be deallocated

Parameters:

client - The client to unregister

makeGUID

public static java.lang.String makeGUID()

Create a globally unique identifier for naming instances

Returns:

New globally unique identifier

registerPushToken

public void registerPushToken(java.lang.String token)

Notify the Respoke SDK that this device should register itself for push notifications

Parameters:

token - The token that identifies the device to GCMS.

unregisterPushServices

public void unregisterPushServices(Respoke.TaskCompletionListener completionListener)

Unregister this device from the Respoke push notification service and stop any future notifications until it is re-registered

Parameters:

completionListener - A listener to be notified of the success of the asynchronous unregistration operation

clientConnected

public void clientConnected(RespokeClient client)

Notify the shared SDK instance that the specified client has connected. This is for internal use only, and should never be called by your client application.

Parameters:

client - The client that just connected