Batch Android SDK/com.batch.android/BatchProfileAttributeEditor

BatchProfileAttributeEditor

open class BatchProfileAttributeEditor : InstallDataEditor

Batch Profile Attribute Editor

Profiles centralize data and events from multiple sources (Apps, Websites, APIs) in a single place based on the Custom ID. They also store a profile's email address and email subscriptions.

The Batch Profile Attribute Editor allows you to update profiles to:

Set attributes Set email subscription status and email address Set a language ®ion

Properties

TAG

val TAG: String = "InstallDataEditor"

Functions

addToArray

open fun addToArray(@NonNull key: String, @NonNull value: String): BatchProfileAttributeEditor

Add a string value in the specified array attribute.

open fun addToArray(@NonNull key: String, @NonNull values: List<String>): BatchProfileAttributeEditor

Add a list of strings in the specified array attribute.

removeAttribute

open fun removeAttribute(@NonNull key: String): BatchProfileAttributeEditor

Removes a custom attribute.

removeFromArray

open fun removeFromArray(@NonNull key: String, @NonNull value: String): BatchProfileAttributeEditor

Removes a string from an array attribute.

open fun removeFromArray(@NonNull key: String, @NonNull values: List<String>): BatchProfileAttributeEditor

Removes a list of strings from an array attribute.

save

open fun save()

Save all of the pending changes made in that editor.

setAttribute

open fun setAttribute(@NonNull key: String, value: Boolean): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, value: Double): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, @NonNull value: String): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, @NonNull value: URI): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, @NonNull value: Date): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, @NonNull value: List<String>): BatchProfileAttributeEditor

open fun setAttribute(@NonNull key: String, value: Long): BatchProfileAttributeEditor

Set a custom profile attribute for a key.

setEmailAddress

open fun setEmailAddress(@Nullable email: String): BatchProfileAttributeEditor

Set the profile email address.

setEmailMarketingSubscription

open fun setEmailMarketingSubscription(@NonNull state: BatchEmailSubscriptionState): BatchProfileAttributeEditor

Set the profile email marketing subscription state.

setLanguage

open fun setLanguage(@Nullable language: String): BatchProfileAttributeEditor

Set the language of this profile.

setPhoneNumber

open fun setPhoneNumber(@Nullable phoneNumber: String): BatchProfileAttributeEditor

Set the profile phone number.

setRegion

open fun setRegion(@Nullable region: String): BatchProfileAttributeEditor

Set the region of this profile.

setSMSMarketingSubscription

open fun setSMSMarketingSubscription(@NonNull state: BatchSMSSubscriptionState): BatchProfileAttributeEditor

Set the profile SMS marketing subscription state.