SFMC SDK/com.salesforce.marketingcloud.sfmcsdk.components.identity/Identity/Builder

Builder

class Builder

Builder class for the Identity class that allows the identity to be modified. This builder provides a fluent API for setting identity properties and building a new Identity instance.

Usage Example

val builder = identity.newBuilder()
builder.setProfileId("John Doe")
    .setPartyIdentificationName("John")
    .putAttribute("key", "value")
val newIdentity = builder.build()
Content copied to clipboard

See also

for the immutable identity class

Functions

Link copied to clipboard
fun build(): Identity

Builds the Identity object with the current builder configuration. This method creates an immutable Identity instance with all the properties set through the builder.

Link copied to clipboard
fun clearAllAttributes(): Identity.Builder

Clears the value of all attributes effectively setting them to null.

Link copied to clipboard
fun clearAttribute(key: String): Identity.Builder

Clears the value of the specified attribute effectively setting it to null.

Link copied to clipboard
fun clearAttributes(vararg keys: String): Identity.Builder
fun clearAttributes(keys: List<String>): Identity.Builder

Clears the value of the specified attributes effectively setting them to null.

Link copied to clipboard
fun putAllAttributes(from: Map<out String, String?>): Identity.Builder

Updates or adds all the values from the passed in map. Attributes are shared by both Marketing Cloud Engagement and Mobile App Messaging.

Link copied to clipboard
fun putAttribute(key: String, value: String?): Identity.Builder

Updates or adds the value of an entry for the given key in the attribute map. Attributes are shared by both Marketing Cloud Engagement and Mobile App Messaging.

Link copied to clipboard
fun setAttributes(from: Map<out String, String?>): Identity.Builder

First clears the values of all existing attributes values. Then updates or adds the values from the passed in map. Note: attribute keys cannot be removed, only the value can be cleared or set to null.

Link copied to clipboard
fun setPartyIdentificationName(value: String?): Identity.Builder

Sets the party identification name, used by Mobile App Messaging. If the value is null or empty, the field will be set to null.

Link copied to clipboard
fun setPartyIdentificationNumber(value: String?): Identity.Builder

Sets the party identification number, used by Mobile App Messaging. This represents a unique identifier for the user. This is typically used to store a system-generated or external ID that uniquely identifies the user within your organization's systems. If the value is null or empty, the field will be set to null.

Link copied to clipboard
fun setPartyIdentificationType(value: String?): Identity.Builder

Sets the party identification type, used by Mobile App Messaging. If the value is null or empty, the field will be set to null.

Link copied to clipboard
fun setProfileId(value: String): Identity.Builder

Sets the profile ID for the identity. The profile ID serves as the unique identifier for the user and is used by Marketing Cloud Engagement. If the value is null, blank, or empty, the value will be ignored and a warning will be logged.