public interface

RegistrationManager

com.salesforce.marketingcloud.registration.RegistrationManager

Summary

Nested Classes
interface RegistrationManager.Editor This class handles the setting of customer configurable values in the SDK. 
interface RegistrationManager.RegistrationEventListener  
Constants
int MAX_MT_ATTRIBUTE_KEY_SIZE
Public Methods
abstract RegistrationManager.Editor edit()
Returns an instance of RegistrationManager.Editor which can be used to update the SDK's configurable values like contactKey, attributes or tags.
abstract Map<String, String> getAttributes()
Getter for attributes map.
abstract String getContactKey()
Getter for contactKey, formerly known as SubscriberKey in the SDK.
abstract String getDeviceId()
Getter for the running device's unique identifier.
abstract String getSignedString()
Getter for "Signed String"
abstract String getSystemToken()
Getter for Google's Push Notification Token
abstract Set<String> getTags()
Getter for tags
abstract void registerForRegistrationEvents(RegistrationManager.RegistrationEventListener listener)
Register a registrationEventListener that will be notified when Registration related events happen.
abstract void unregisterForRegistrationEvents(RegistrationManager.RegistrationEventListener listener)
Unregister a registrationEventListener

Constants

public static final int MAX_MT_ATTRIBUTE_KEY_SIZE

Constant Value: 128 (0x00000080)

Public Methods

public abstract RegistrationManager.Editor edit ()

Returns an instance of RegistrationManager.Editor which can be used to update the SDK's configurable values like contactKey, attributes or tags.

Returns

public abstract Map<String, String> getAttributes ()

Getter for attributes map.

Returns
  • a non-null map of the attributes set in the registration

public abstract String getContactKey ()

Getter for contactKey, formerly known as SubscriberKey in the SDK. The name has been changed to align the SDK with the Salesforce Marketing Cloud Contacts DB. If ContactKey is unset then a random GUID will be set in the Marketing Cloud.

Note: once this value is set from the SDK it may not be empty or null. There is no way to clear or unset a Contact Key.

Returns
  • null or the set value.

public abstract String getDeviceId ()

Getter for the running device's unique identifier.

Returns
  • the unique identifier in the Marketing Cloud for this device.

public abstract String getSignedString ()

Getter for "Signed String"

Returns
  • value set locally in the SDK or null.

public abstract String getSystemToken ()

Getter for Google's Push Notification Token

Returns
  • null or the value issued by Google

public abstract Set<String> getTags ()

Getter for tags

Returns
  • a non-null set of String

public abstract void registerForRegistrationEvents (RegistrationManager.RegistrationEventListener listener)

Register a registrationEventListener that will be notified when Registration related events happen.

Parameters
listener the class that implements the interface

public abstract void unregisterForRegistrationEvents (RegistrationManager.RegistrationEventListener listener)

Unregister a registrationEventListener

Parameters
listener the class that implements the interface