com.microstrategy.ushersdk

Class UsherSdk

java.lang.Object

com.microstrategy.ushersdk.UsherSdk

public class UsherSdk
extends java.lang.Object

The UsherSdk Singleton class provides initialization for the Usher SDK. It should only be initialized once for an application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsherSdk.Configuration The UsherSdk.Configuration abstract class wraps various properties related to the UsherSdk initialization.

Method Summary

Modifier and Type	Method and Description
static UsherSdk	get() Returns the UsherSdk object.
java.util.Locale	getLocale() Returns the Locale of the app.
static void	init(android.app.Application application, java.lang.String serverUrl, java.lang.String appId) Initializes the UsherSdk object with an application, server URL, and application ID.
static void	init(UsherSdk.Configuration configuration) Initializes the UsherSdk object with the provided UsherSdk.Configuration.
boolean	isDebugLogMode() Returns the log mode of the app.
void	setDebugLogMode(boolean isDebugLogMode) Set log mode for the app
void	setLocale(java.util.Locale locale) Set Locale for the app
void	uploadDeviceNotificationToken(java.lang.String deviceNotificationToken, CompleteCallback callback) Returns a CompleteCallback after uploading the device notification token to the server.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static UsherSdk get()

Returns the UsherSdk object.

Returns:

the UsherSdk object.

uploadDeviceNotificationToken

public void uploadDeviceNotificationToken(java.lang.String deviceNotificationToken,
                                          CompleteCallback callback)

Returns a CompleteCallback after uploading the device notification token to the server.

Parameters:

deviceNotificationToken - the notification token to be uploaded to the server

callback - the callback to receive the result of uploading the device notification token to the server

init

public static void init(UsherSdk.Configuration configuration)

Initializes the UsherSdk object with the provided UsherSdk.Configuration. This can be used for some customized settings of UsherSdk.Configuration.networkConnectionTimeout() and UsherSdk.Configuration.enableTrustOnFirstUse(). See UsherSdk.Configuration.builder(Application) for details.

Parameters:

configuration - See UsherSdk.Configuration

init

public static void init(android.app.Application application,
                        java.lang.String serverUrl,
                        java.lang.String appId)

Initializes the UsherSdk object with an application, server URL, and application ID.

Parameters:

application - the application that the UsherSdk is initialized for

serverUrl - the server URL to handle HTTP requests

appId - the identification number of the application

setLocale

public void setLocale(@Nonnull
                      java.util.Locale locale)

Set Locale for the app

Parameters:

locale - the Locale to set

getLocale

@Nonnull
public java.util.Locale getLocale()

Returns the Locale of the app. If not set before, returns Locale.ENGLISH

Returns:

the Locale object

setDebugLogMode

public void setDebugLogMode(boolean isDebugLogMode)

Set log mode for the app

Parameters:

isDebugLogMode - the log body mode to set. true if set to log body mode; false otherwise

isDebugLogMode

public boolean isDebugLogMode()

Returns the log mode of the app.

Returns:

true if a user has set debugging log mode; false otherwise.