Adobe Campaign Standard API reference

extensionVersion

Returns the running version of the Campaign Standard extension.

Android Java

data-slots=heading, code

data-repeat=2

Syntax

public String extensionVersion()

Example

String campaignExtensionVersion = Campaign.extensionVersion();

Android Kotlin

data-slots=heading, code

data-repeat=2

Syntax

public String extensionVersion()

Example

val campaignExtensionVersion: String = Campaign.extensionVersion()

iOS Swift

data-slots=heading, code

data-repeat=2

Syntax

static var extensionVersion: String

Example

let campaignVersion = Campaign.extensionVersion

iOS Objective-C

data-slots=heading, code

data-repeat=2

Syntax

+ (NSString * _Nonnull)extensionVersion

Example

NSString *campaignVersion = [AEPMobileCampaign extensionVersion];

registerExtension

data-variant=warning

data-slots=text1, text2
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.

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.

Android Java

data-slots=heading, code

data-repeat=2

Syntax

public static void resetLinkageFields()

Example

Campaign.resetLinkageFields()

Android Kotlin

data-slots=heading, code

data-repeat=2

Syntax

public static void resetLinkageFields()

Example

Campaign.resetLinkageFields()

iOS Swift

data-slots=heading, code

data-repeat=2

Syntax

static func resetLinkageFields()

Example

Campaign.resetLinkageFields()

iOS Objective-C

data-slots=heading, code

data-repeat=2

Syntax

+ (void) resetLinkageFields

Example

[AEPMobileCampaign resetLinkageFields];

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.

Android Java

data-slots=heading, code

data-repeat=2

Syntax

public static void setLinkageFields(final Map<String, String> linkageFields)

Example

HashMap<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);

Android Kotlin

data-slots=heading, code

data-repeat=2

Syntax

public static void setLinkageFields(final Map<String, String> linkageFields)

Example

val linkageFields: Map<String, String?> = mapOf(
    "cusFirstName" to "John",
    "cusLastName" to "Doe",
    "cusEmail" to "john.doe@email.com"
)

Campaign.setLinkageFields(linkageFields)

iOS Swift

data-slots=heading, code

data-repeat=2

Syntax

static func setLinkageFields(_ linkageFields: [String: String])

Example

Campaign.setLinkageFields(linkageFields: ["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])

iOS Objective-C

data-slots=heading, code

data-repeat=2

Syntax

+ (void) setLinkageFields:(NSDictionary<NSString *,NSString *> * _Nonnull)

Example

[AEPMobileCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];