com.microstrategy.usher

Class Usher.Configuration.Builder

java.lang.Object

com.microstrategy.usher.Usher.Configuration.Builder

Enclosing class:

Usher.Configuration

public abstract static class Usher.Configuration.Builder
extends java.lang.Object

The Usher.Configuration.Builder abstract class allows the user to create and return a Usher.Configuration object. For example:
return Configuration.builder()
.usherAppScheme(usherAppScheme)
.callback(callback)
.gcmSenderId(123)
.enableLog(true)
.serverModelConfig(serverModelConfig)
.badgeConditionConfig(badgeConditionConfig)
.build();

Method Summary

Modifier and Type	Method and Description
abstract Usher.Configuration.Builder	badgeConditionConfig(BadgeCondition.Config badgeConditionConfig) Returns the Usher.Configuration.Builder for the Usher.Configuration.badgeConditionConfig() component of the Usher.Configuration object.
abstract Usher.Configuration	build() Builds the Usher.Configuration object that wraps fields related to the server configuration.
abstract Usher.Configuration.Builder	callback(Usher.Configuration.Callback callback) Returns the Usher.Configuration.Builder for the Usher.Configuration.callback() component of the Usher.Configuration object.
abstract Usher.Configuration.Builder	enableLog(boolean enableLog) Returns the Usher.Configuration.Builder for the Usher.Configuration.enableLog() component of the Usher.Configuration object.
abstract Usher.Configuration.Builder	gcmSenderId(java.lang.String gcmSenderId) Deprecated.
abstract Usher.Configuration.Builder	pushNotificationHandlerActivityClass(java.lang.Class<? extends android.app.Activity> aClass) Returns the Usher.Configuration.Builder for the Usher.Configuration.pushNotificationHandlerActivityClass() component of the Usher.Configuration object.
abstract Usher.Configuration.Builder	serverModelConfig(ServerModel.PreConfig serverModelConfig) Returns the Usher.Configuration.Builder for the Usher.Configuration.serverModelConfig() component of the Usher.Configuration object.
abstract Usher.Configuration.Builder	usherAppScheme(java.lang.String usherAppScheme) Returns the Usher.Configuration.Builder for the Usher.Configuration.usherAppScheme() component of the Usher.Configuration object.

Methods inherited from class java.lang.Object

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

Method Detail

usherAppScheme

public abstract Usher.Configuration.Builder usherAppScheme(java.lang.String usherAppScheme)

Returns the Usher.Configuration.Builder for the Usher.Configuration.usherAppScheme() component of the Usher.Configuration object. By default, its value is .

Parameters:

usherAppScheme - the supported Deeplink scheme

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.usherAppScheme() component of the Usher.Configuration object.

callback

public abstract Usher.Configuration.Builder callback(@Nullable
                                                     Usher.Configuration.Callback callback)

Returns the Usher.Configuration.Builder for the Usher.Configuration.callback() component of the Usher.Configuration object.

Parameters:

callback - the callback to receive the result of the SDK initialization

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.callback() component of the Usher.Configuration object.

gcmSenderId

@Deprecated
public abstract Usher.Configuration.Builder gcmSenderId(@Nullable
                                                                    java.lang.String gcmSenderId)

Deprecated.

Returns the Usher.Configuration.Builder for the Usher.Configuration.gcmSenderId() component of the Usher.Configuration object. Be default, it will be use the built-in GCM sender ID. Please note: GCM is set to be retired by Google by April 2019. After that, you must provide a FCM configuration file to support push notification functionality.

Parameters:

gcmSenderId - the GCM sender ID

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.gcmSenderId() component of the Usher.Configuration object.

enableLog

public abstract Usher.Configuration.Builder enableLog(boolean enableLog)

Returns the Usher.Configuration.Builder for the Usher.Configuration.enableLog() component of the Usher.Configuration object.

Parameters:

enableLog - true if you want to enable the debug log; false otherwise

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.enableLog() component of the Usher.Configuration object.

serverModelConfig

public abstract Usher.Configuration.Builder serverModelConfig(ServerModel.PreConfig serverModelConfig)

Returns the Usher.Configuration.Builder for the Usher.Configuration.serverModelConfig() component of the Usher.Configuration object. Through Usher.Configuration.serverModelConfig(), you can specify your default server configuration.

Parameters:

serverModelConfig - See ServerModel.PreConfig

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.serverModelConfig() component of the Usher.Configuration object.

pushNotificationHandlerActivityClass

public abstract Usher.Configuration.Builder pushNotificationHandlerActivityClass(@Nullable
                                                                                 java.lang.Class<? extends android.app.Activity> aClass)

Returns the Usher.Configuration.Builder for the Usher.Configuration.pushNotificationHandlerActivityClass() component of the Usher.Configuration object. An instance of this class will be started when you click on the notification action of an inbox push notification. If you do not provide this class, the action will trigger a BroadcastReceiver with action UsherSdkIntentContracts.ACTION_OBSERVE_INBOX_ENTITY and its JSON value, which you can access through Intent using param UsherSdkIntentContracts.EXTRA_PARAM.

Parameters:

aClass - the Class of a Activity that you want to set

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.pushNotificationHandlerActivityClass() component of the Usher.Configuration object.

badgeConditionConfig

public abstract Usher.Configuration.Builder badgeConditionConfig(BadgeCondition.Config badgeConditionConfig)

Returns the Usher.Configuration.Builder for the Usher.Configuration.badgeConditionConfig() component of the Usher.Configuration object. If your app would like to enforce the badge conditions that are defined on Network Manager, you are expected to specify the corresponding value to indicate that your app supports such restrictions. By default, all badge condition restrictions are turned off in the MicroStrategy Badge SDK; this means that the Location and Bluetooth configuration requirements on Network Manager will be not honored if your app does not implement such features.

Parameters:

badgeConditionConfig - See BadgeCondition.Config

Returns:

the Usher.Configuration.Builder for the Usher.Configuration.badgeConditionConfig() component of the Usher.Configuration object.

build

public abstract Usher.Configuration build()

Builds the Usher.Configuration object that wraps fields related to the server configuration.

Returns:

the Usher.Configuration object that wraps fields related to the server configuration.