com.deltadna.android.sdk

Class DDNA.Configuration

java.lang.Object

com.deltadna.android.sdk.DDNA.Configuration

Enclosing class:

DDNA

public static final class DDNA.Configuration
extends java.lang.Object

Class for providing a configuration when initialising the SDK through DDNA.initialise(Configuration) inside of an Application class.

Field Summary

Fields

Modifier and Type	Field and Description
protected android.app.Application	application
protected Settings	settings

Constructor Summary

Constructors

Constructor and Description
Configuration(android.app.Application application, java.lang.String environmentKey, java.lang.String collectUrl, java.lang.String engageUrl)

Method Summary

Modifier and Type	Method and Description
DDNA.Configuration	clientVersion(java.lang.String clientVersion) Sets the client version.
DDNA.Configuration	hashSecret(java.lang.String hashSecret) Sets the hash secret.
DDNA.Configuration	platform(java.lang.String platform) Sets the value for the platform field.
DDNA.Configuration	userId(java.lang.String userId) Sets the user id.
DDNA.Configuration	withSettings(DDNA.SettingsModifier modifier) Allows changing of Settings values.

Methods inherited from class java.lang.Object

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

Field Detail

application

protected final android.app.Application application

settings

protected final Settings settings

Constructor Detail

Configuration

public Configuration(android.app.Application application,
                     java.lang.String environmentKey,
                     java.lang.String collectUrl,
                     java.lang.String engageUrl)

Method Detail

hashSecret

public DDNA.Configuration hashSecret(@Nullable
                                     java.lang.String hashSecret)

Sets the hash secret.

Parameters:

hashSecret - the hash secret

Returns:

this DDNA.Configuration instance

clientVersion

public DDNA.Configuration clientVersion(@Nullable
                                        java.lang.String clientVersion)

Sets the client version.

Could be the VERSION_NAME from your application's BuildConfig.

Parameters:

clientVersion - the client version

Returns:

this DDNA.Configuration instance

userId

public DDNA.Configuration userId(@Nullable
                                 java.lang.String userId)

Sets the user id.

You may use this method to set the user id if you create one in your Application class, else you may ignore it and set the id later, or let the SDK create its own id.

Parameters:

userId - the user id

Returns:

this DDNA.Configuration instance

platform

public DDNA.Configuration platform(java.lang.String platform)

Sets the value for the platform field.

If not set the value will default to ClientInfo.platform().

Parameters:

platform - the platform

Returns:

this DDNA.Configuration instance

See Also:

ClientInfo.PLATFORM_ANDROID, ClientInfo.PLATFORM_AMAZON

withSettings

public DDNA.Configuration withSettings(DDNA.SettingsModifier modifier)

Allows changing of Settings values.

Parameters:

modifier - the settings modifier

Returns:

this DDNA.Configuration instance