com.salesforce.marketingcloud.registration.RegistrationManager.Editor |
This class handles the setting of customer configurable values in the SDK. All validation for length,
type, nullability, etc. is completed within the editor. When the editor's commit
method is called the SDK will compare the running configuration to the previously successfully processed
configuration. If there have been any changes they will be stored locally and transmitted to the
Marketing Cloud Servers.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract RegistrationManager.Editor |
addTag(String tag)
Adds the provided to tag to the registration.
| ||||||||||
abstract RegistrationManager.Editor |
addTags(String... tags)
Adds the Collection provided to tags.
| ||||||||||
abstract RegistrationManager.Editor |
addTags(Iterable<String> tags)
Adds the Iterable provided to tags.
| ||||||||||
abstract RegistrationManager.Editor |
clearAttribute(String key)
Clear the value for the attributes of the key provided.
| ||||||||||
abstract RegistrationManager.Editor |
clearAttributes(String... keys)
Clear the value for the attributes of the keys provided.
| ||||||||||
abstract RegistrationManager.Editor |
clearAttributes(Iterable<String> keys)
Clear the value for the attribute of the keys provided.
| ||||||||||
abstract RegistrationManager.Editor |
clearTags()
Removes all customer configured tags.
| ||||||||||
abstract boolean |
commit()
You must call this method for your changes to be stored locally and transmitted to the
Marketing Cloud Servers.
| ||||||||||
abstract RegistrationManager.Editor |
removeTag(String tag)
Removes the provided tag from the tags in your registration.
| ||||||||||
abstract RegistrationManager.Editor |
removeTags(String... tags)
Removes the Collection provided from tags.
| ||||||||||
abstract RegistrationManager.Editor |
removeTags(Iterable<String> tags)
Removes the
tags provided from the registration | ||||||||||
abstract RegistrationManager.Editor |
setAttribute(String key, String value)
Sets a
key /value pair as an attribute in the registration. | ||||||||||
abstract RegistrationManager.Editor |
setContactKey(String contactKey)
Setter for contactKey which was formerly known in the SDK as SubscriberKey.
| ||||||||||
abstract RegistrationManager.Editor |
setSignedString(String signedString)
Setter for "Signed String" in the SDK.
|
Adds the provided to tag to the registration.
tag | to add to your Marketing Cloud configuration. |
---|
Adds the Collection provided to tags.
tags | to add to your Marketing Cloud configuration. |
---|
Adds the Iterable provided to tags.
tags | to add to your Marketing Cloud configuration. |
---|
Clear the value for the attributes of the key provided.
key | key that represents the attribute value to be cleared |
---|
Clear the value for the attributes of the keys provided.
keys | the collection of attribute keys for which you wish to clear the values. |
---|
Clear the value for the attribute of the keys provided.
keys | the collection of attributes keys for which you wish to clear the values. |
---|
Removes all customer configured tags.
You must call this method for your changes to be stored locally and transmitted to the Marketing Cloud Servers.
true
if the data was saved successfully and the Registration
was scheduled
for delivery to the Marketing Cloud Servers.
Removes the provided tag from the tags in your registration.
tag | to be removed from the registration |
---|
Removes the Collection provided from tags.
tags | is the list of items to remove. |
---|
Removes the tags
provided from the registration
tags | is the list of items to remove. |
---|
Sets a key
/value
pair as an attribute in the registration. This key
must
already
exist in your Marketing Cloud Server configuration. There is no way to add an attribute from the SDK.
key | a non-null String string between 1 and 128 characters in length. |
---|---|
value | a non-null String string |
Setter for contactKey which was formerly known in the SDK as SubscriberKey. The name was changed to align the SDK's nomenclature with the Marketing Cloud Contacts DB.
A ContactKey, once set, may never be unset. If a ContactKey is not provided the Marketing Cloud will generate a random GUID to serve as a ContactKey until one is set by the SDK.
contactKey | any non-null String string with at least 1 non-white space character. |
---|
Setter for "Signed String" in the SDK. The value
is passed through the SDK to the Marketing
Cloud Servers and can be used as a means to authenticate devices/contacts.
Setting this value to null will remove the field from the Registration payload. All other non-empty String values are passed along as-is. Empty values are ignored.
This feature must be enabled on your account by your account manager prior to use.
signedString | can be null or any non-empty String string. |
---|