Adobe Campaign Standard API reference
extensionVersion
Returns the running version of the Campaign Standard extension.
Java
Syntax
Copied to your clipboardpublic String extensionVersion()
Example
Copied to your clipboardString campaignExtensionVersion = Campaign.extensionVersion();
Kotlin
Syntax
Copied to your clipboardpublic String extensionVersion()
Example
Copied to your clipboardval campaignExtensionVersion: String = Campaign.extensionVersion()
Swift
Syntax
Copied to your clipboardstatic var extensionVersion: String
Example
Copied to your clipboardlet campaignVersion = Campaign.extensionVersion
Objective-C
Syntax
Copied to your clipboard+ (NSString * _Nonnull)extensionVersion
Example
Copied to your clipboardNSString *campaignVersion = [AEPMobileCampaign extensionVersion];
Java
Syntax
Copied to your clipboardpublic String extensionVersion()
Example
Copied to your clipboardString campaignExtensionVersion = Campaign.extensionVersion();
Kotlin
Syntax
Copied to your clipboardpublic String extensionVersion()
Example
Copied to your clipboardval campaignExtensionVersion: String = Campaign.extensionVersion()
Swift
Syntax
Copied to your clipboardstatic var extensionVersion: String
Example
Copied to your clipboardlet campaignVersion = Campaign.extensionVersion
Objective-C
Syntax
Copied to your clipboard+ (NSString * _Nonnull)extensionVersion
Example
Copied to your clipboardNSString *campaignVersion = [AEPMobileCampaign extensionVersion];
registerExtension
This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.
Use MobileCore.registerExtensions() API instead.
Registers the Campaign Standard extension with the Mobile Core.
This API has been deprecated as of version 2.0.0. Please use the Mobile Core registerExtension API instead.
This API no longer exists in the Adobe Campaign Standard extension. Instead, the extension should be registered by calling the registerExtensions API in the MobileCore. Please see the updated SDK initialization steps at the migrate to Swift tutorial.
This API has been deprecated as of version 2.0.0. Please use the Mobile Core registerExtension API instead.
This API no longer exists in the Adobe Campaign Standard extension. Instead, the extension should be registered by calling the registerExtensions API in the MobileCore. Please see the updated SDK initialization steps at the migrate to Swift tutorial.
resetLinkageFields
Clears previously stored linkage fields in the mobile SDK and triggers a Campaign rules download request to the configured Campaign server.
This method unregisters any previously registered rules with the Rules Engine and clears cached rules from the most recent rules download.
setLinkageFields
Sets the Campaign linkage fields (CRM IDs) in Mobile SDK to be used for downloading personalized messages from Campaign.
The set linkage fields are stored as a base64 encoded JSON string in memory and they are sent in a custom HTTP header X-InApp-Auth.
Java
Syntax
Copied to your clipboardpublic static void setLinkageFields(final Map<String, String> linkageFields)
Example
Copied to your clipboardHashMap<String, String> linkageFields = new HashMap<String, String>();linkageFields.put("cusFirstName", "John");linkageFields.put("cusLastName", "Doe");linkageFields.put("cusEmail", "john.doe@email.com");Campaign.setLinkageFields(linkageFields);
Kotlin
Syntax
Copied to your clipboardpublic static void setLinkageFields(final Map<String, String> linkageFields)
Example
Copied to your clipboardval linkageFields: Map<String, String?> = mapOf("cusFirstName" to "John","cusLastName" to "Doe","cusEmail" to "john.doe@email.com")Campaign.setLinkageFields(linkageFields)
Swift
Syntax
Copied to your clipboardstatic func setLinkageFields(_ linkageFields: [String: String])
Example
Copied to your clipboardCampaign.setLinkageFields(linkageFields: ["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])
Objective-C
Syntax
Copied to your clipboard+ (void) setLinkageFields:(NSDictionary<NSString *,NSString *> * _Nonnull)
Example
Copied to your clipboard[AEPMobileCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];
Java
Syntax
Copied to your clipboardpublic static void setLinkageFields(final Map<String, String> linkageFields)
Example
Copied to your clipboardHashMap<String, String> linkageFields = new HashMap<String, String>();linkageFields.put("cusFirstName", "John");linkageFields.put("cusLastName", "Doe");linkageFields.put("cusEmail", "john.doe@email.com");Campaign.setLinkageFields(linkageFields);
Kotlin
Syntax
Copied to your clipboardpublic static void setLinkageFields(final Map<String, String> linkageFields)
Example
Copied to your clipboardval linkageFields: Map<String, String?> = mapOf("cusFirstName" to "John","cusLastName" to "Doe","cusEmail" to "john.doe@email.com")Campaign.setLinkageFields(linkageFields)
Swift
Syntax
Copied to your clipboardstatic func setLinkageFields(_ linkageFields: [String: String])
Example
Copied to your clipboardCampaign.setLinkageFields(linkageFields: ["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])
Objective-C
Syntax
Copied to your clipboard+ (void) setLinkageFields:(NSDictionary<NSString *,NSString *> * _Nonnull)
Example
Copied to your clipboard[AEPMobileCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];
