Adobe Campaign Standard API reference

This document lists information about the previous versions of the Adobe Experience Platform Mobile SDKs. Check out this page for latest versions and solution support of the Mobile SDKs.

extensionVersion

Returns the running version of the Campaign Standard extension.

Android

Java

Syntax

public String extensionVersion()
Copied to your clipboard
public String extensionVersion()

Example

Campaign.extensionVersion();
Copied to your clipboard
Campaign.extensionVersion();

iOS

Swift

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

let campaignVersion = ACPCampaign.extensionVersion()
Copied to your clipboard
let campaignVersion = ACPCampaign.extensionVersion()

Objective-C

Syntax

+ (NSString * _Nonnull)extensionVersion
Copied to your clipboard
+ (NSString * _Nonnull)extensionVersion

Example

NSString *campaignVersion = [ACPCampaign extensionVersion];
Copied to your clipboard
NSString *campaignVersion = [ACPCampaign extensionVersion];

React Native

JavaScript

Syntax

extensionVersion(): Promise<string>
Copied to your clipboard
extensionVersion(): Promise<string>

Example

ACPCampaign.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPCampaign version: " + version));
Copied to your clipboard
ACPCampaign.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPCampaign version: " + version));

Java

Syntax

public String extensionVersion()
Copied to your clipboard
public String extensionVersion()

Example

Campaign.extensionVersion();
Copied to your clipboard
Campaign.extensionVersion();

Swift

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

let campaignVersion = ACPCampaign.extensionVersion()
Copied to your clipboard
let campaignVersion = ACPCampaign.extensionVersion()

Objective-C

Syntax

+ (NSString * _Nonnull)extensionVersion
Copied to your clipboard
+ (NSString * _Nonnull)extensionVersion

Example

NSString *campaignVersion = [ACPCampaign extensionVersion];
Copied to your clipboard
NSString *campaignVersion = [ACPCampaign extensionVersion];

JavaScript

Syntax

extensionVersion(): Promise<string>
Copied to your clipboard
extensionVersion(): Promise<string>

Example

ACPCampaign.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPCampaign version: " + version));
Copied to your clipboard
ACPCampaign.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPCampaign version: " + version));

registerExtension

Registers the Campaign Standard extension with the Mobile Core.

Android

Java

Syntax

public static void registerExtension()
Copied to your clipboard
public static void registerExtension()

Example

Campaign.registerExtension();
Copied to your clipboard
Campaign.registerExtension();

iOS

Swift

Syntax

+ (void) registerExtension
Copied to your clipboard
+ (void) registerExtension

Example

ACPCampaign.registerExtension()
Copied to your clipboard
ACPCampaign.registerExtension()

Objective-C

Syntax

+ (void) registerExtension
Copied to your clipboard
+ (void) registerExtension

Example

[ACPCampaign registerExtension];
Copied to your clipboard
[ACPCampaign registerExtension];

React Native

Java

Syntax

public static void registerExtension()
Copied to your clipboard
public static void registerExtension()

Example

Campaign.registerExtension();
Copied to your clipboard
Campaign.registerExtension();

Swift

Syntax

+ (void) registerExtension
Copied to your clipboard
+ (void) registerExtension

Example

ACPCampaign.registerExtension()
Copied to your clipboard
ACPCampaign.registerExtension()

Objective-C

Syntax

+ (void) registerExtension
Copied to your clipboard
+ (void) registerExtension

Example

[ACPCampaign registerExtension];
Copied to your clipboard
[ACPCampaign registerExtension];

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

Syntax

public static void resetLinkageFields()
Copied to your clipboard
public static void resetLinkageFields()

Example

Campaign.resetLinkageFields()
Copied to your clipboard
Campaign.resetLinkageFields()

iOS

Swift

Syntax

+ (void) resetLinkageFields
Copied to your clipboard
+ (void) resetLinkageFields

Example

ACPCampaign.resetLinkageFields()
Copied to your clipboard
ACPCampaign.resetLinkageFields()

Objective-C

Syntax

+ (void) resetLinkageFields
Copied to your clipboard
+ (void) resetLinkageFields

Example

[ACPCampaign resetLinkageFields];
Copied to your clipboard
[ACPCampaign resetLinkageFields];

React Native

JavaScript

Syntax

resetLinkageFields()
Copied to your clipboard
resetLinkageFields()

Example

ACPCampaign.resetLinkageFields();
Copied to your clipboard
ACPCampaign.resetLinkageFields();

Java

Syntax

public static void resetLinkageFields()
Copied to your clipboard
public static void resetLinkageFields()

Example

Campaign.resetLinkageFields()
Copied to your clipboard
Campaign.resetLinkageFields()

Swift

Syntax

+ (void) resetLinkageFields
Copied to your clipboard
+ (void) resetLinkageFields

Example

ACPCampaign.resetLinkageFields()
Copied to your clipboard
ACPCampaign.resetLinkageFields()

Objective-C

Syntax

+ (void) resetLinkageFields
Copied to your clipboard
+ (void) resetLinkageFields

Example

[ACPCampaign resetLinkageFields];
Copied to your clipboard
[ACPCampaign resetLinkageFields];

JavaScript

Syntax

resetLinkageFields()
Copied to your clipboard
resetLinkageFields()

Example

ACPCampaign.resetLinkageFields();
Copied to your clipboard
ACPCampaign.resetLinkageFields();

setLinkageFields

Sets the Campaign linkage fields (CRM IDs) in the 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

Syntax

public static void setLinkageFields(final Map<String, String> linkageFields)
Copied to your clipboard
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);
Copied to your clipboard
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);

iOS

Swift

Syntax

+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields
Copied to your clipboard
+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields

Example

ACPCampaign.setLinkageFields(["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])
Copied to your clipboard
ACPCampaign.setLinkageFields(["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])

Objective-C

Syntax

+ (void) setLinkageFields: (NSDictionary<NSString*, NSString*>*) linkageFields
Copied to your clipboard
+ (void) setLinkageFields: (NSDictionary<NSString*, NSString*>*) linkageFields

Example

[ACPCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];
Copied to your clipboard
[ACPCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];

React Native

JavaScript

Syntax

setLinkageFields(linkageFields: { string: string })
Copied to your clipboard
setLinkageFields(linkageFields: { string: string })

Example

ACPCampaign.setLinkageFields({"firstName": "John"});
Copied to your clipboard
ACPCampaign.setLinkageFields({"firstName": "John"});

Java

Syntax

public static void setLinkageFields(final Map<String, String> linkageFields)
Copied to your clipboard
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);
Copied to your clipboard
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);

Swift

Syntax

+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields
Copied to your clipboard
+ (void) setLinkageFields: (nonnull NSDictionary<NSString*, NSString*>*) linkageFields

Example

ACPCampaign.setLinkageFields(["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])
Copied to your clipboard
ACPCampaign.setLinkageFields(["cusFirstName": "John", "cusLastName": "Doe", "cusEmail": "john.doe@email.com"])

Objective-C

Syntax

+ (void) setLinkageFields: (NSDictionary<NSString*, NSString*>*) linkageFields
Copied to your clipboard
+ (void) setLinkageFields: (NSDictionary<NSString*, NSString*>*) linkageFields

Example

[ACPCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];
Copied to your clipboard
[ACPCampaign setLinkageFields:@{@"cusFirstName" : @"John", @"cusLastName": @"Doe", @"cusEmail": @"john.doe@email.com"}];

JavaScript

Syntax

setLinkageFields(linkageFields: { string: string })
Copied to your clipboard
setLinkageFields(linkageFields: { string: string })

Example

ACPCampaign.setLinkageFields({"firstName": "John"});
Copied to your clipboard
ACPCampaign.setLinkageFields({"firstName": "John"});

Overview

Migration

Was this helpful?

Yes

Adobe Campaign Standard API reference

extensionVersion.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

registerExtension

Java

Swift

Objective-C

Java

Swift

Objective-C

resetLinkageFields

Java

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

setLinkageFields

Java

Swift

Objective-C

JavaScript

Java

Swift

Objective-C

JavaScript

extensionVersion

Java