Registration Class

Package 

com.salesforce.marketingcloud.registration

Class Definition 

1data class Registration

A data class representing device registration information for the Salesforce Marketing Cloud SDK.

Properties 

appId 

1@JvmField
2val appId: String

The application identifier.

appVersion 

1@JvmField
2val appVersion: String

The version of the application.

attributes 

1@JvmField
2val attributes: Map<String, String>

A map of custom attributes associated with the registration.

contactKey 

1@JvmField
2val contactKey: String?

The contact key identifier (nullable).

deviceId 

1@JvmField
2val deviceId: String

The unique device identifier.

dst 

1@JvmField
2val dst: Boolean

Daylight saving time indicator.

hwid 

1@JvmField
2val hwid: String

Hardware identifier.

locale 

1@JvmField
2val locale: String

The device locale setting.

locationEnabled 

1@JvmField
2val locationEnabled: Boolean

Indicates whether location services are enabled.

platform 

1@JvmField
2val platform: String

The platform name (e.g., Android).

platformVersion 

1@JvmField
2val platformVersion: String

The version of the platform/OS.

proximityEnabled 

1@JvmField
2val proximityEnabled: Boolean

Indicates whether proximity features are enabled.

pushEnabled 

1@JvmField
2val pushEnabled: Boolean

Indicates whether push notifications are enabled.

sdkVersion 

1@JvmField
2val sdkVersion: String

The version of the Marketing Cloud SDK.

signedString 

1@JvmField
2val signedString: String?

A signed string for authentication (nullable).

systemToken 

1@JvmField
2val systemToken: String?

The system token for push notifications (nullable).

tags 

1@JvmField
2val tags: Set<String>

A set of tags associated with the registration.

timeZone 

1@JvmField
2val timeZone: Int

The time zone offset in minutes.

Methods 

Each property has a corresponding getter method with the same name:

appId() 

1fun appId(): String

Returns the application identifier.

appVersion() 

1fun appVersion(): String

Returns the application version.

attributes() 

1fun attributes(): Map<String, String>

Returns the attributes map.

contactKey() 

1fun contactKey(): String?

Returns the contact key (nullable).

deviceId() 

1fun deviceId(): String

Returns the device identifier.

dst() 

1fun dst(): Boolean

Returns the daylight saving time status.

hwid() 

1fun hwid(): String

Returns the hardware identifier.

locale() 

1fun locale(): String

Returns the locale.

locationEnabled() 

1fun locationEnabled(): Boolean

Returns the location enabled status.

platform() 

1fun platform(): String

Returns the platform name.

platformVersion() 

1fun platformVersion(): String

Returns the platform version.

proximityEnabled() 

1fun proximityEnabled(): Boolean

Returns the proximity enabled status.

pushEnabled() 

1fun pushEnabled(): Boolean

Returns the push enabled status.

sdkVersion() 

1fun sdkVersion(): String

Returns the SDK version.

signedString() 

1fun signedString(): String?

Returns the signed string (nullable).

systemToken() 

1fun systemToken(): String?

Returns the system token (nullable).

tags() 

1fun tags(): Set<String>

Returns the set of tags.

timeZone() 

1fun timeZone(): Int

Returns the time zone offset.

Platform Target 

  • androidJvm - This class is available for Android/JVM targets only.