DDNA (deltaDNA SDK 4.11.3.1 API)

java.lang.Object
- com.deltadna.android.sdk.DDNA

```
public abstract class DDNA
extends java.lang.Object
```
Singleton class for accessing the deltaDNA SDK.
The singleton instance must first be initialised by calling initialise(Configuration) from a Application's Application.onCreate() method. Following this call an instance can be accessed at any time through instance().
Prior to sending events, or performing engagements, the SDK must be started through startSdk() or startSdk(String). stopSdk() should be called when the game is stopped.
To customise behaviour after initialisation you can call getSettings() to get access to the Settings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DDNA.Configuration` Class for providing a configuration when initialising the SDK through `initialise(Configuration)` inside of an `Application` class.
`static interface`	`DDNA.SettingsModifier`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract DDNA`	`clearPersistentData()` Clears persistent data, such as the user ID, Collect events, and Engage cache.
`abstract DDNA`	`clearRegistrationId()` Clears the registration id associated with this device for disabling push notifications.
`abstract DDNA`	`downloadImageAssets()` Downloads image assets from the session configuration in the background.
`abstract DDNA`	`forgetMe()` Forgets the current user and stops them from being tracked.
`abstract java.lang.String`	`getCrossGameUserId()` Gets the cross game user ID used for cross promotion.
`EngageFactory`	`getEngageFactory()` Gets the Engage factory which provides an easier way of requesting Engage actions.
`abstract java.lang.String`	`getRegistrationId()` Gets the registration id for push notifications.
`java.lang.String`	`getSessionId()`
`Settings`	`getSettings()`
`java.lang.String`	`getUserId()` Gets the user id.
`static DDNA`	`initialise(DDNA.Configuration configuration)`
`static DDNA`	`instance()`
`abstract boolean`	`isStarted()` Queries the status of the SDK.
`DDNA`	`newSession()` Changes the session id.
`abstract EventAction`	`recordEvent(Event event)` Records an event with Collect.
`abstract EventAction`	`recordEvent(java.lang.String name)` Records an event with Collect.
`abstract EventAction`	`recordNotificationDismissed(android.os.Bundle payload)` Record when a push notification has been dismissed.
`abstract EventAction`	`recordNotificationOpened(boolean launch, android.os.Bundle payload)` Record when a push notification has been opened.
`DDNA`	`register(EventListener listener)` Registers an `EventListener` for receiving event notifications.
`DDNA`	`register(IEventListener listener)`
`abstract <E extends Engagement> DDNA`	`requestEngagement(E engagement, EngageListener<E> listener)` Makes an Engage request.
`abstract DDNA`	`requestEngagement(java.lang.String decisionPoint, EngageListener<Engagement> listener)` Makes an Engage request.
`abstract DDNA`	`requestSessionConfiguration()` Makes a session configuration request.
`DDNA`	`setAdvertisingId(java.lang.String advertisingId)`
`abstract DDNA`	`setCrossGameUserId(java.lang.String crossGameUserId)` Sets the cross game user ID for the current user to be used for cross promotion.
`abstract DDNA`	`setRegistrationId(java.lang.String registrationId)` Sets the registration id for push notifications.
`abstract DDNA`	`startSdk()` Starts the SDK.
`abstract DDNA`	`startSdk(java.lang.String userId)` Starts the SDK.
`abstract DDNA`	`stopSdk()` Stops the SDK.
`abstract DDNA`	`stopTrackingMe()` Stops tracking the current user.
`DDNA`	`unregister(EventListener listener)` Unregisters an `EventListener` so that it will no longer receive event notifications.
`DDNA`	`unregister(IEventListener listener)`
`abstract DDNA`	`upload()` Sends pending events to our platform.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - initialise
```
public static DDNA initialise(DDNA.Configuration configuration)
```
  - instance
```
public static DDNA instance()
```
  - startSdk
```
public abstract DDNA startSdk()
```
    Starts the SDK.
    This method needs to be called before sending events or making engagements.
    
    Returns:
    
    this DDNA instance
  - startSdk
```
public abstract DDNA startSdk(@Nullable
                              java.lang.String userId)
```
    Starts the SDK.
    This method needs to be called before sending events or making engagements.
    
    Parameters:
    
    userId - the user id, may be null in which case the SDK will generate an id.
    
    Returns:
    
    this DDNA instance
  - stopSdk
```
public abstract DDNA stopSdk()
```
    Stops the SDK.
    Calling this method sends a 'gameEnded' event to Collect, disables background uploads and automatic session refreshing.
    
    Returns:
    
    this DDNA instance
  - isStarted
```
public abstract boolean isStarted()
```
    Queries the status of the SDK.
    
    Returns:
    
    true if the SDK has been started, else false
  - recordEvent
```
public abstract EventAction recordEvent(java.lang.String name)
```
    Records an event with Collect.
    
    Parameters:
    
    name - the name of the event
    
    Returns:
    
    the EventAction for this event
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null or empty
  - recordEvent
```
public abstract EventAction recordEvent(Event event)
```
    Records an event with Collect.
    
    Parameters:
    
    event - the event
    
    Returns:
    
    the EventAction for this event
    
    Throws:
    
    java.lang.IllegalArgumentException - if the event is null
  - recordNotificationOpened
```
public abstract EventAction recordNotificationOpened(boolean launch,
                                                     android.os.Bundle payload)
```
    Record when a push notification has been opened.
    
    Parameters:
    
    launch - whether the notification launched the app
    
    payload - the payload of the push notification
    
    Returns:
    
    the EventAction for this event
  - recordNotificationDismissed
```
public abstract EventAction recordNotificationDismissed(android.os.Bundle payload)
```
    Record when a push notification has been dismissed.
    
    Parameters:
    
    payload - the payload of the push notification
    
    Returns:
    
    the EventAction for this event
  - requestEngagement
```
public abstract DDNA requestEngagement(java.lang.String decisionPoint,
                                       EngageListener<Engagement> listener)
```
    Makes an Engage request.
    The result will be passed into the provided listener through one of the callback methods on the main UI thread, even if this method was called from a background thread.
    
    Parameters:
    
    decisionPoint - the decision point for the engagement
    
    listener - listener for the result
    
    Returns:
    
    this DDNA instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the decisionPoint is null or empty
    
    See Also:
    
    EngageFactory
  - requestEngagement
```
public abstract <E extends Engagement> DDNA requestEngagement(E engagement,
                                                              EngageListener<E> listener)
```
    Makes an Engage request.
    The result will be passed into the provided listener through one of the callback methods on the main UI thread, even if this method was called from a background thread.
    
    Parameters:
    
    engagement - the engagement
    
    listener - listener for the result
    
    Returns:
    
    this DDNA instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the engagement is null
    
    See Also:
    
    EngageFactory
  - requestSessionConfiguration
```
public abstract DDNA requestSessionConfiguration()
```
    Makes a session configuration request. This method should be called if a session configuration request has previously failed.
    The result will be notified via the EventListener.onSessionConfigured(boolean) or EventListener.onSessionConfigurationFailed(Throwable) callback methods for any registered EventListeners.
    
    Returns:
    
    this DDNA instance
  - upload
```
public abstract DDNA upload()
```
    Sends pending events to our platform.
    This is usually called automatically, but in the case that automatic event uploads are disabled the game will be responsible for calling this method at suitable points in the game flow.
    
    Returns:
    
    this DDNA instance
  - downloadImageAssets
```
public abstract DDNA downloadImageAssets()
```
    Downloads image assets from the session configuration in the background.
    This happens automatically whenever a session configuration request takes places, such as during a new session or when requestSessionConfiguration() is called.
    The success or failure will be notified to all registered EventListeners.
    
    Returns:
    
    this DDNA instance
  - getCrossGameUserId
```
@Nullable
public abstract java.lang.String getCrossGameUserId()
```
    Gets the cross game user ID used for cross promotion.
    
    Returns:
    
    the cross game user ID, may be null if not set
  - setCrossGameUserId
```
public abstract DDNA setCrossGameUserId(java.lang.String crossGameUserId)
```
    Sets the cross game user ID for the current user to be used for cross promotion.
    
    Parameters:
    
    crossGameUserId - the cross game user ID
    
    Returns:
    
    this DDNA instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the crossGameUserId is null or empty
  - getRegistrationId
```
@Nullable
public abstract java.lang.String getRegistrationId()
```
    Gets the registration id for push notifications.
    
    Returns:
    
    the registration id, may be null if not set
  - setRegistrationId
```
public abstract DDNA setRegistrationId(@Nullable
                                       java.lang.String registrationId)
```
    Sets the registration id for push notifications.
    
    Parameters:
    
    registrationId - the registration id, may be null in order to unregister from notifications
    
    Returns:
    
    this DDNA instance
  - clearRegistrationId
```
public abstract DDNA clearRegistrationId()
```
    Clears the registration id associated with this device for disabling push notifications.
    
    Returns:
    
    this DDNA instance
  - clearPersistentData
```
public abstract DDNA clearPersistentData()
```
    Clears persistent data, such as the user ID, Collect events, and Engage cache.
    This also normally stops the SDK, as a re-start will be required in order to re-initialise the user ID.
    
    Returns:
    
    this DDNA instance
  - forgetMe
```
public abstract DDNA forgetMe()
```
    Forgets the current user and stops them from being tracked. This will send a GDPR delete request.
    Any subsequent calls on the SDK will succeed, but not send/request anything to/from the Platform.
    The status can be cleared by starting the SDK with a new user through startSdk(String) or by clearing the persistent data with clearPersistentData().
    
    Returns:
    
    this DDNA instance
  - stopTrackingMe
```
public abstract DDNA stopTrackingMe()
```
    Stops tracking the current user. This will NOT send a GDPR delete request.
    Any subsequent calls on the SDK will succeed, but not send/request anything to/from the Platform.
    The status can be cleared by starting the SDK with a new user through startSdk(String) or by clearing the persistent data with clearPersistentData().
    
    Returns:
    
    this DDNA instance
  - newSession
```
public final DDNA newSession()
```
    Changes the session id.
    
    Returns:
    
    this DDNA instance
  - getSessionId
```
public final java.lang.String getSessionId()
```
  - getUserId
```
@Nullable
public final java.lang.String getUserId()
```
    Gets the user id.
    
    Returns:
    
    the user id, may be null if the user id hasn't been set or generated by the SDK at this point
  - getEngageFactory
```
public final EngageFactory getEngageFactory()
```
    Gets the Engage factory which provides an easier way of requesting Engage actions.
    
    Returns:
    
    the EngageFactory
  - getSettings
```
public final Settings getSettings()
```
  - register
```
public final DDNA register(EventListener listener)
```
    Registers an EventListener for receiving event notifications.
    
    Parameters:
    
    listener - the listener to register
    
    Returns:
    
    this DDNA instance
  - unregister
```
public final DDNA unregister(EventListener listener)
```
    Unregisters an EventListener so that it will no longer receive event notifications.
    
    Parameters:
    
    listener - the listener to unregister
    
    Returns:
    
    this DDNA instance
  - register
```
public final DDNA register(IEventListener listener)
```
  - unregister
```
public final DDNA unregister(IEventListener listener)
```
  - setAdvertisingId
```
public DDNA setAdvertisingId(@Nullable
                             java.lang.String advertisingId)
```

Class DDNA

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

initialise

instance

startSdk

startSdk

stopSdk

isStarted

recordEvent

recordEvent

recordNotificationOpened

recordNotificationDismissed

requestEngagement

requestEngagement

requestSessionConfiguration

upload

downloadImageAssets

getCrossGameUserId

setCrossGameUserId

getRegistrationId

setRegistrationId

clearRegistrationId

clearPersistentData

forgetMe

stopTrackingMe

newSession

getSessionId

getUserId

getEngageFactory

getSettings

register

unregister

register

unregister

setAdvertisingId