Java

Syntax

Copy
public static void clearQueue()
Copied to your clipboard
public static void clearQueue()

Example

Copy
Analytics.clearQueue();
Copied to your clipboard
Analytics.clearQueue();

Swift

Syntax

Copy
static func clearQueue()
Copied to your clipboard
static func clearQueue()

Example

Copy
ACPAnalytics.clearQueue()
Copied to your clipboard
ACPAnalytics.clearQueue()

Objective-C

Syntax

Copy
+ (void) clearQueue;
Copied to your clipboard
+ (void) clearQueue;

Example

Copy
[ACPAnalytics clearQueue];
Copied to your clipboard
[ACPAnalytics clearQueue];

JavaScript

Syntax

Copy
clearQueue();
Copied to your clipboard
clearQueue();

Example

Copy
ACPAnalytics.clearQueue();
Copied to your clipboard
ACPAnalytics.clearQueue();

Dart

Syntax

Copy
Future<void> clearQueue();
Copied to your clipboard
Future<void> clearQueue();

Example

Copy
FlutterACPAnalytics.clearQueue();
Copied to your clipboard
FlutterACPAnalytics.clearQueue();

Cordova

Syntax

Copy
ACPAnalytics.clearQueue = function(success, fail);
Copied to your clipboard
ACPAnalytics.clearQueue = function(success, fail);

• success is a callback containing a general success message if the clearQueue API executed without any errors.
• fail is a callback containing error information if the clearQueue API was executed with errors.

Example

Copy
ACPAnalytics.clearQueue(function (handleCallback) {
  console.log("AdobeExperienceSDK: Clear queued hits successful. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to clear queued hits: " + handleError);
});
Copied to your clipboard
ACPAnalytics.clearQueue(function (handleCallback) {
  console.log("AdobeExperienceSDK: Clear queued hits successful. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to clear queued hits: " + handleError);
});

C#

Syntax

Copy
public static void ClearQueue()
Copied to your clipboard
public static void ClearQueue()

Example

Copy
ACPAnalytics.ClearQueue();
Copied to your clipboard
ACPAnalytics.ClearQueue();

C#

Syntax

Copy
public static void ClearQueue ();
Copied to your clipboard
public static void ClearQueue ();

Example

Copy
ACPAnalytics.ClearQueue();
Copied to your clipboard
ACPAnalytics.ClearQueue();

Java

Copy
String analyticsExtensionVersion = Analytics.extensionVersion();
Copied to your clipboard
String analyticsExtensionVersion = Analytics.extensionVersion();

Swift

Syntax

Copy
static func extensionVersion()
Copied to your clipboard
static func extensionVersion()

Example

Copy
let analyticsExtensionVersion  = ACPAnalytics.extensionVersion()
Copied to your clipboard
let analyticsExtensionVersion  = ACPAnalytics.extensionVersion()

Objective-C

Syntax

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

Example

Copy
NSString *analyticsExtensionVersion = [ACPAnalytics extensionVersion];
Copied to your clipboard
NSString *analyticsExtensionVersion = [ACPAnalytics extensionVersion];

JavaScript

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

Dart

Copy
String analyticsExtensionVersion = await FlutterACPAnalytics.extensionVersion;
Copied to your clipboard
String analyticsExtensionVersion = await FlutterACPAnalytics.extensionVersion;

Cordova

Copy
ACPAnalytics.extensionVersion(function(version) {  
   console.log("ACPAnalytics version: " + version);
}, function(error) {  
   console.log(error);  
});
Copied to your clipboard
ACPAnalytics.extensionVersion(function(version) {  
   console.log("ACPAnalytics version: " + version);
}, function(error) {  
   console.log(error);  
});

C#

Copy
string analyticsExtensionVersion = ACPAnalytics.ExtensionVersion();
Copied to your clipboard
string analyticsExtensionVersion = ACPAnalytics.ExtensionVersion();

C#

Copy
string analyticsExtensionVersion = ACPAnalytics.ExtensionVersion();
Copied to your clipboard
string analyticsExtensionVersion = ACPAnalytics.ExtensionVersion();

Java

Syntax

Copy
 public static void getQueueSize(final AdobeCallback<Long> callback)
Copied to your clipboard
 public static void getQueueSize(final AdobeCallback<Long> callback)

• callback is invoked with the queue size value. When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with queue size.

Example

Copy
Analytics.getQueueSize(new AdobeCallback<Long>() {
    @Override
    public void call(final Long queueSize) {
        // handle the queueSize
    }
});
Copied to your clipboard
Analytics.getQueueSize(new AdobeCallback<Long>() {
    @Override
    public void call(final Long queueSize) {
        // handle the queueSize
    }
});

Swift

Syntax

Copy
static func getQueueSize(_ callback: @escaping (UInt) -> Void)
Copied to your clipboard
static func getQueueSize(_ callback: @escaping (UInt) -> Void)

Example

Copy
ACPAnalytics.getQueueSize { (queueSize) in    
     // handle queue size   
}
Copied to your clipboard
ACPAnalytics.getQueueSize { (queueSize) in    
     // handle queue size   
}

Objective-C

Syntax

Copy
+ (void) getQueueSize: (nonnull void (^) (NSUInteger queueSize)) callback;
Copied to your clipboard
+ (void) getQueueSize: (nonnull void (^) (NSUInteger queueSize)) callback;

• callback is invoked with the queue size value.

Example

Copy
[ACPAnalytics getQueueSize: ^(NSUInteger queueSize) {    
    // handle queue size
}];
Copied to your clipboard
[ACPAnalytics getQueueSize: ^(NSUInteger queueSize) {    
    // handle queue size
}];

JavaScript

Syntax

Copy
getQueueSize(): Promise<?integer>;
Copied to your clipboard
getQueueSize(): Promise<?integer>;

Example

Copy
ACPAnalytics.getQueueSize().then(size => console.log("AdobeExperienceSDK: Queue size: " + size));
Copied to your clipboard
ACPAnalytics.getQueueSize().then(size => console.log("AdobeExperienceSDK: Queue size: " + size));

Dart

Syntax

Copy
Future<int> getQueueSize;
Copied to your clipboard
Future<int> getQueueSize;

Example

Copy
int queueSize;

try {
    queueSize = await FlutterACPAnalytics.queueSize;
} on PlatformException {
    log("Failed to get the queue size");
}
Copied to your clipboard
int queueSize;

try {
    queueSize = await FlutterACPAnalytics.queueSize;
} on PlatformException {
    log("Failed to get the queue size");
}

Cordova

Syntax

Copy
ACPAnalytics.getQueueSize = function(success, fail);
Copied to your clipboard
ACPAnalytics.getQueueSize = function(success, fail);

• success is a callback containing the queue size if the getQueueSize API executed without any errors.
• fail is a callback containing error information if the getQueueSize API was executed with errors.

Example

Copy
ACPAnalytics.getQueueSize(function (handleCallback) {
  console.log("AdobeExperienceSDK: Queue size: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to get queue size: " + handleError);
});
Copied to your clipboard
ACPAnalytics.getQueueSize(function (handleCallback) {
  console.log("AdobeExperienceSDK: Queue size: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to get queue size: " + handleError);
});

C#

Syntax

Copy
public static void GetQueueSize(AdobeGetQueueSizeCallback callback)
Copied to your clipboard
public static void GetQueueSize(AdobeGetQueueSizeCallback callback)

• callback is a callback containing the queue size if the GetQueueSize API executed without any errors.

Example

Copy
[MonoPInvokeCallback(typeof(AdobeGetQueueSizeCallback))]
public static void HandleAdobeGetQueueSizeCallback(long queueSize)
{
    Debug.Log("Queue size is : " + queueSize);
}
ACPAnalytics.GetQueueSize(HandleAdobeGetQueueSizeCallback);
Copied to your clipboard
[MonoPInvokeCallback(typeof(AdobeGetQueueSizeCallback))]
public static void HandleAdobeGetQueueSizeCallback(long queueSize)
{
    Debug.Log("Queue size is : " + queueSize);
}
ACPAnalytics.GetQueueSize(HandleAdobeGetQueueSizeCallback);

C#

iOS

Syntax

Copy
public unsafe static void GetQueueSize (Action<nuint> callback);
Copied to your clipboard
public unsafe static void GetQueueSize (Action<nuint> callback);

• callback is a callback containing the queue size if the GetQueueSize API executed without any errors.

Example

Copy
ACPAnalytics.GetQueueSize(callback => {
  Console.WriteLine("Queue size: " + callback);
});
Copied to your clipboard
ACPAnalytics.GetQueueSize(callback => {
  Console.WriteLine("Queue size: " + callback);
});

Android

Syntax

Copy
public unsafe static void GetQueueSize (IAdobeCallback callback);
Copied to your clipboard
public unsafe static void GetQueueSize (IAdobeCallback callback);

• callback is a callback containing the queue size if the GetQueueSize API executed without any errors.

Example

Copy
ACPAnalytics.GetQueueSize(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Queue size: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}
Copied to your clipboard
ACPAnalytics.GetQueueSize(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Queue size: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}

Swift

Syntax

Copy
static func getQueueSize(completionHandler: @escaping (UInt, Error?) -> Void)
Copied to your clipboard
static func getQueueSize(completionHandler: @escaping (UInt, Error?) -> Void)

Example

Copy
ACPAnalytics.getQueueSizeWithCompletionHandler { (queueSize, error) in    
    // Handle error (if non-nil) or use queueSize.  
}
Copied to your clipboard
ACPAnalytics.getQueueSizeWithCompletionHandler { (queueSize, error) in    
    // Handle error (if non-nil) or use queueSize.  
}

Objective-C

Syntax

Copy
+ (void) getQueueSizeWithCompletionHandler: (nonnull void (^) (NSUInteger queueSize, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getQueueSizeWithCompletionHandler: (nonnull void (^) (NSUInteger queueSize, NSError* __nullable error)) completionHandler;

• completionHandler is invoked with the queue size value or an NSError if an unexpected error occurs or the request times out.

Example

Copy
[ACPAnalytics getQueueSizeWithCompletionHandler: ^(NSUInteger queueSize, NSError * _Nullable error) {    
    // Handle error (if non-nil) or use queueSize.
}];
Copied to your clipboard
[ACPAnalytics getQueueSizeWithCompletionHandler: ^(NSUInteger queueSize, NSError * _Nullable error) {    
    // Handle error (if non-nil) or use queueSize.
}];

Java

Syntax

Copy
 public static void
   getTrackingIdentifier(final AdobeCallback<String> callback)
Copied to your clipboard
 public static void
   getTrackingIdentifier(final AdobeCallback<String> callback)

• callback is invoked with the tracking Identifier string value. When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with analytics tracking identifier.

Example

Copy
Analytics.getTrackingIdentifier(new AdobeCallback<String>() {
    @Override
    public void call(final String trackingIdentifier) {
        // check the trackingIdentifier value    
    }
});
Copied to your clipboard
Analytics.getTrackingIdentifier(new AdobeCallback<String>() {
    @Override
    public void call(final String trackingIdentifier) {
        // check the trackingIdentifier value    
    }
});

Swift

Syntax

Copy
static func getTrackingIdentifier(_ callback: @escaping (String?) -> Void)
Copied to your clipboard
static func getTrackingIdentifier(_ callback: @escaping (String?) -> Void)

Example

Copy
ACPAnalytics.getTrackingIdentifier { (trackingIdentifier) in
    // check the trackingIdentifier value  
}
Copied to your clipboard
ACPAnalytics.getTrackingIdentifier { (trackingIdentifier) in
    // check the trackingIdentifier value  
}

Objective-C

Syntax

Copy
+ (void) getTrackingIdentifier: (nonnull void (^) (NSString* __nullable trackingIdentifier)) callback;
Copied to your clipboard
+ (void) getTrackingIdentifier: (nonnull void (^) (NSString* __nullable trackingIdentifier)) callback;

• callback is invoked with the tracking Identifier string value.

Example

Copy
[ACPAnalytics getTrackingIdentifier:^(NSString * _Nullable trackingIdentifier) {
    // check the trackingIdentifier value  
}];
Copied to your clipboard
[ACPAnalytics getTrackingIdentifier:^(NSString * _Nullable trackingIdentifier) {
    // check the trackingIdentifier value  
}];

JavaScript

Syntax

Copy
getTrackingIdentifier();
Copied to your clipboard
getTrackingIdentifier();

• callback is invoked with the tracking Identifier string value.

Example

Copy
ACPAnalytics.getTrackingIdentifier().then(identifier => console.log("AdobeExperienceSDK: Tracking identifier: " + identifier));
Copied to your clipboard
ACPAnalytics.getTrackingIdentifier().then(identifier => console.log("AdobeExperienceSDK: Tracking identifier: " + identifier));

Dart

Syntax

Copy
Future<String> getTrackingIdentifier;
Copied to your clipboard
Future<String> getTrackingIdentifier;

Example

Copy
String trackingId;

try {
    trackingId = await FlutterACPAnalytics.trackingIdentifier;
} on PlatformException {
    log("Failed to get the tracking identifier");
}
Copied to your clipboard
String trackingId;

try {
    trackingId = await FlutterACPAnalytics.trackingIdentifier;
} on PlatformException {
    log("Failed to get the tracking identifier");
}

Cordova

Syntax

Copy
ACPAnalytics.getTrackingIdentifier = function(success, fail);
Copied to your clipboard
ACPAnalytics.getTrackingIdentifier = function(success, fail);

• success is a callback containing the tracking Identifier string value.
• fail is a callback containing error information if the getTrackingIdentifier API was executed with errors.

Example

Copy
ACPAnalytics.getTrackingIdentifier(function (handleCallback) {
  console.log("AdobeExperienceSDK: Retrieved tracking identifier: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to retrieve tracking identifier: " + handleError);
});
Copied to your clipboard
ACPAnalytics.getTrackingIdentifier(function (handleCallback) {
  console.log("AdobeExperienceSDK: Retrieved tracking identifier: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to retrieve tracking identifier: " + handleError);
});

C#

Syntax

Copy
public static void GetTrackingIdentifier(AdobeGetTrackingIdentifierCallback callback)
Copied to your clipboard
public static void GetTrackingIdentifier(AdobeGetTrackingIdentifierCallback callback)

• callback is a callback containing the tracking Identifier string value.

Example

Copy
[MonoPInvokeCallback(typeof(AdobeGetTrackingIdentifierCallback))]
public static void HandleAdobeGetTrackingIdentifierCallback(string trackingIdentifier)
{
    Debug.Log("Tracking identifier is : " + trackingIdentifier);
}
ACPAnalytics.GetTrackingIdentifier(HandleAdobeGetTrackingIdentifierCallback);
Copied to your clipboard
[MonoPInvokeCallback(typeof(AdobeGetTrackingIdentifierCallback))]
public static void HandleAdobeGetTrackingIdentifierCallback(string trackingIdentifier)
{
    Debug.Log("Tracking identifier is : " + trackingIdentifier);
}
ACPAnalytics.GetTrackingIdentifier(HandleAdobeGetTrackingIdentifierCallback);

C#

iOS

Syntax

Copy
public unsafe static void GetTrackingIdentifier (Action<NSString> callback);
Copied to your clipboard
public unsafe static void GetTrackingIdentifier (Action<NSString> callback);

• callback is a callback containing the tracking Identifier string value.

Example

Copy
ACPAnalytics.GetTrackingIdentifier(callback => {
  Console.WriteLine("Tracking identifier: " + callback);
});
Copied to your clipboard
ACPAnalytics.GetTrackingIdentifier(callback => {
  Console.WriteLine("Tracking identifier: " + callback);
});

Android

Syntax

Copy
public unsafe static void GetTrackingIdentifier (IAdobeCallback callback);
Copied to your clipboard
public unsafe static void GetTrackingIdentifier (IAdobeCallback callback);

• callback is a callback containing the tracking Identifier string value.

Example

Copy
ACPAnalytics.GetTrackingIdentifier(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Tracking identifier: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}
Copied to your clipboard
ACPAnalytics.GetTrackingIdentifier(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Tracking identifier: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}

Swift

Syntax

Copy
static func getTrackingIdentifier(completionHandler: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getTrackingIdentifier(completionHandler: @escaping (String?, Error?) -> Void)

• completionHandler is invoked with the tracking Identifier string value. or an NSError if an unexpected error occurs or the request times out.

Example

Copy
ACPAnalytics.getTrackingIdentifierWithCompletionHandler { (trackingIdentifier, error) in    
     // Handle the error (if non-nil) or use the trackingIdentifier value.
}
Copied to your clipboard
ACPAnalytics.getTrackingIdentifierWithCompletionHandler { (trackingIdentifier, error) in    
     // Handle the error (if non-nil) or use the trackingIdentifier value.
}

Objective-C

Syntax

Copy
+ (void) getTrackingIdentifierWithCompletionHandler: (nonnull void (^) (NSString* __nullable trackingIdentifier, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getTrackingIdentifierWithCompletionHandler: (nonnull void (^) (NSString* __nullable trackingIdentifier, NSError* __nullable error)) completionHandler;

Example

Copy
[ACPAnalytics getTrackingIdentifierWithCompletionHandler:^(NSString * _Nullable trackingIdentifier, NSError * _Nullable error) {
    // Handle the error (if non-nil) or use the trackingIdentifier value.
}];
Copied to your clipboard
[ACPAnalytics getTrackingIdentifierWithCompletionHandler:^(NSString * _Nullable trackingIdentifier, NSError * _Nullable error) {
    // Handle the error (if non-nil) or use the trackingIdentifier value.
}];

Java

Syntax

Copy
public static void getVisitorIdentifier(AdobeCallback<String> callback)
Copied to your clipboard
public static void getVisitorIdentifier(AdobeCallback<String> callback)

• callback is invoked with the visitor identifier value. When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with visitor identifier.

Example

Copy
Analytics.getVisitorIdentifier(new AdobeCallback<String>() {
    @Override
    public void call(final String visitorIdentifier) {
        // check the visitorIdentifier value    
    }
});
Copied to your clipboard
Analytics.getVisitorIdentifier(new AdobeCallback<String>() {
    @Override
    public void call(final String visitorIdentifier) {
        // check the visitorIdentifier value    
    }
});

Swift

Syntax

Copy
static func getVisitorIdentifier(_ callback: @escaping (String?) -> Void)
Copied to your clipboard
static func getVisitorIdentifier(_ callback: @escaping (String?) -> Void)

• callback is invoked with the visitor identifier value.

Example

Copy
ACPAnalytics.getVisitorIdentifier { (visitorIdentifier) in
    // check the visitorIdentifier value  
}
Copied to your clipboard
ACPAnalytics.getVisitorIdentifier { (visitorIdentifier) in
    // check the visitorIdentifier value  
}

Objective-C

Syntax

Copy
+ (void) getVisitorIdentifier: (nonnull void (^) (NSString* __nullable visitorIdentifier)) callback;
Copied to your clipboard
+ (void) getVisitorIdentifier: (nonnull void (^) (NSString* __nullable visitorIdentifier)) callback;

Example

Copy
[ACPAnalytics getVisitorIdentifier:^(NSString * _Nullable visitorIdentifier) {
    // check the visitorIdentifier value   
}];
Copied to your clipboard
[ACPAnalytics getVisitorIdentifier:^(NSString * _Nullable visitorIdentifier) {
    // check the visitorIdentifier value   
}];

JavaScript

Syntax

Copy
getVisitorIdentifier();
Copied to your clipboard
getVisitorIdentifier();

Example

Copy
ACPAnalytics.getVisitorIdentifier().then(vid => console.log("AdobeExperienceSDK: Visitor identifier: " + vid));
Copied to your clipboard
ACPAnalytics.getVisitorIdentifier().then(vid => console.log("AdobeExperienceSDK: Visitor identifier: " + vid));

Dart

Syntax

Copy
Future<String> visitorIdentifier;
Copied to your clipboard
Future<String> visitorIdentifier;

Example

Copy
String visitorId;

try {
    visitorId = await FlutterACPAnalytics.visitorIdentifier;
} on PlatformException {
    visitorId = "Failed to get the visitor identifier";
}
Copied to your clipboard
String visitorId;

try {
    visitorId = await FlutterACPAnalytics.visitorIdentifier;
} on PlatformException {
    visitorId = "Failed to get the visitor identifier";
}

Cordova

Syntax

Copy
ACPAnalytics.getVisitorIdentifier = function(success, fail);
Copied to your clipboard
ACPAnalytics.getVisitorIdentifier = function(success, fail);

• success is a callback containing the Visitor Identifier string if the getVisitorIdentifier API executed without any errors.
• fail is a callback containing error information if the getVisitorIdentifier API was executed with errors.

Example

Copy
ACPAnalytics.getVisitorIdentifier(function (handleCallback) {
  console.log("AdobeExperienceSDK: Retrieved custom visitor identifier: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to retrieve custom visitor identifier: " + handleError);
});
Copied to your clipboard
ACPAnalytics.getVisitorIdentifier(function (handleCallback) {
  console.log("AdobeExperienceSDK: Retrieved custom visitor identifier: " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to retrieve custom visitor identifier: " + handleError);
});

C#

Syntax

Copy
public static void GetVisitorIdentifier(AdobeGetVisitorIdentifierCallback callback)
Copied to your clipboard
public static void GetVisitorIdentifier(AdobeGetVisitorIdentifierCallback callback)

• callback is a callback containing the Visitor Identifier string if the GetVisitorIdentifier API executed without any errors.

Example

Copy
[MonoPInvokeCallback(typeof(AdobeGetVisitorIdentifierCallback))]
public static void HandleAdobeGetVisitorIdentifierCallback(string visitorIdentifier)
{
    Debug.Log("Visitor identifier is : " + visitorIdentifier);
}
ACPAnalytics.GetVisitorIdentifier(HandleAdobeGetVisitorIdentifierCallback);
Copied to your clipboard
[MonoPInvokeCallback(typeof(AdobeGetVisitorIdentifierCallback))]
public static void HandleAdobeGetVisitorIdentifierCallback(string visitorIdentifier)
{
    Debug.Log("Visitor identifier is : " + visitorIdentifier);
}
ACPAnalytics.GetVisitorIdentifier(HandleAdobeGetVisitorIdentifierCallback);

C#

iOS

Syntax

Copy
public unsafe static void GetVisitorIdentifier (Action<NSString> callback);
Copied to your clipboard
public unsafe static void GetVisitorIdentifier (Action<NSString> callback);

• callback is a callback containing the visitor Identifier string value.

Example

Copy
ACPAnalytics.GetVisitorIdentifier(callback => {
  Console.WriteLine("Visitor identifier: " + callback);
});
Copied to your clipboard
ACPAnalytics.GetVisitorIdentifier(callback => {
  Console.WriteLine("Visitor identifier: " + callback);
});

Android

Syntax

Copy
public unsafe static void GetVisitorIdentifier (IAdobeCallback callback);
Copied to your clipboard
public unsafe static void GetVisitorIdentifier (IAdobeCallback callback);

• callback is a callback containing the visitor Identifier string value.

Example

Copy
ACPAnalytics.GetVisitorIdentifier(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Visitor identifier: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}
Copied to your clipboard
ACPAnalytics.GetVisitorIdentifier(new StringCallback());

class StringCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object stringContent)
  {
    if (stringContent != null)
    {
      Console.WriteLine("Visitor identifier: " + stringContent);
    }
    else
    {
      Console.WriteLine("null content in string callback");
    }
  }
}

Swift

Syntax

Copy
static func getVisitorIdentifier(completionHandler: @escaping (String?, Error?) -> Void)
Copied to your clipboard
static func getVisitorIdentifier(completionHandler: @escaping (String?, Error?) -> Void)

• completionHandler is invoked with the visitor identifier value or an NSError if an unexpected error occurs or the request times out.

Example

Copy
ACPAnalytics.getVisitorIdentifierWithCompletionHandler { (visitorIdentifier, error) in
    // Handle the error (if non-nil) or use the visitorIdentifier value
}
Copied to your clipboard
ACPAnalytics.getVisitorIdentifierWithCompletionHandler { (visitorIdentifier, error) in
    // Handle the error (if non-nil) or use the visitorIdentifier value
}

Objective-C

Syntax

Copy
+ (void) getVisitorIdentifierWithCompletionHandler: (nonnull void (^) (NSString* __nullable visitorIdentifier, NSError* __nullable error)) completionHandler;
Copied to your clipboard
+ (void) getVisitorIdentifierWithCompletionHandler: (nonnull void (^) (NSString* __nullable visitorIdentifier, NSError* __nullable error)) completionHandler;

Example

Copy
[ACPAnalytics getVisitorIdentifierWithCompletionHandler:^(NSString * _Nullable visitorIdentifier, NSError * _Nullable error) {
    // Handle the error (if non-nil) or use the visitorIdentifier value
}];
Copied to your clipboard
[ACPAnalytics getVisitorIdentifierWithCompletionHandler:^(NSString * _Nullable visitorIdentifier, NSError * _Nullable error) {
    // Handle the error (if non-nil) or use the visitorIdentifier value
}];

Java

Syntax

Copy
public static void sendQueuedHits()
Copied to your clipboard
public static void sendQueuedHits()

Example

Copy
Analytics.sendQueuedHits();
Copied to your clipboard
Analytics.sendQueuedHits();

Swift

Syntax

Copy
static func sendQueuedHits()
Copied to your clipboard
static func sendQueuedHits()

Example

Copy
ACPAnalytics.sendQueuedHits()
Copied to your clipboard
ACPAnalytics.sendQueuedHits()

Objective-C

Syntax

Copy
+ (void) sendQueuedHits;
Copied to your clipboard
+ (void) sendQueuedHits;

Example

Copy
[ACPAnalytics sendQueuedHits];
Copied to your clipboard
[ACPAnalytics sendQueuedHits];

JavaScript

Syntax

Copy
sendQueuedHits();
Copied to your clipboard
sendQueuedHits();

Example

Copy
ACPAnalytics.sendQueuedHits();
Copied to your clipboard
ACPAnalytics.sendQueuedHits();

Dart

Syntax

Copy
Future<void> sendQueuedHits();
Copied to your clipboard
Future<void> sendQueuedHits();

Example

Copy
FlutterACPAnalytics.sendQueuedHits();
Copied to your clipboard
FlutterACPAnalytics.sendQueuedHits();

Cordova

Syntax

Copy
ACPAnalytics.sendQueuedHits = function(success, fail);
Copied to your clipboard
ACPAnalytics.sendQueuedHits = function(success, fail);

• success is a callback containing a general success message if the sendQueuedHits API executed without any errors.
• fail is a callback containing error information if the sendQueuedHits API was executed with errors.

Example

Copy
ACPAnalytics.sendQueuedHits(function (handleCallback) {
  console.log("AdobeExperienceSDK: Send queued hits successful. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to send queued hits: " + handleError);
});
Copied to your clipboard
ACPAnalytics.sendQueuedHits(function (handleCallback) {
  console.log("AdobeExperienceSDK: Send queued hits successful. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to send queued hits: " + handleError);
});

C#

Syntax

Copy
public static void SendQueuedHits()
Copied to your clipboard
public static void SendQueuedHits()

Example

Copy
ACPAnalytics.SendQueuedHits();
Copied to your clipboard
ACPAnalytics.SendQueuedHits();

C#

Syntax

Copy
public static void SendQueuedHits ();
Copied to your clipboard
public static void SendQueuedHits ();

Example

Copy
ACPAnalytics.SendQueuedHits();
Copied to your clipboard
ACPAnalytics.SendQueuedHits();

Java

Syntax

Copy
 public static void setVisitorIdentifier(final String visitorIdentifier)
Copied to your clipboard
 public static void setVisitorIdentifier(final String visitorIdentifier)

• visitorIdentifier is the new value for the visitor identifier.

Example

Copy
Analytics.setVisitorIdentifier("custom_identifier");
Copied to your clipboard
Analytics.setVisitorIdentifier("custom_identifier");

Swift

Syntax

Copy
static func setVisitorIdentifier(_ visitorIdentifier: String)
Copied to your clipboard
static func setVisitorIdentifier(_ visitorIdentifier: String)

• visitorIdentifier is the new value for the visitor identifier.

Example

Copy
ACPAnalytics.setVisitorIdentifier("custom_identifier")
Copied to your clipboard
ACPAnalytics.setVisitorIdentifier("custom_identifier")

Objective-C

Syntax

Copy
+ (void) setVisitorIdentifier: (nonnull NSString*) visitorIdentifier;
Copied to your clipboard
+ (void) setVisitorIdentifier: (nonnull NSString*) visitorIdentifier;

Example

Copy
[ACPAnalytics setVisitorIdentifier:@"custom_identifier"];
Copied to your clipboard
[ACPAnalytics setVisitorIdentifier:@"custom_identifier"];

JavaScript

Syntax

Copy
setVisitorIdentifier(visitorIdentifier);
Copied to your clipboard
setVisitorIdentifier(visitorIdentifier);

• visitorIdentifier is the new value for the visitor identifier.

Example

Copy
ACPAnalytics.setVisitorIdentifier("custom_identifier");
Copied to your clipboard
ACPAnalytics.setVisitorIdentifier("custom_identifier");

Dart

Syntax

Copy
Future<void> setVisitorIdentifier(visitorIdentifier);
Copied to your clipboard
Future<void> setVisitorIdentifier(visitorIdentifier);

• visitorIdentifier is the new value for the visitor identifier.

Example

Copy
FlutterACPAnalytics.setVisitorIdentifier("yourVisitorId");
Copied to your clipboard
FlutterACPAnalytics.setVisitorIdentifier("yourVisitorId");

Cordova

Syntax

Copy
ACPAnalytics.setVisitorIdentifier(visitorIdentifier, success, fail);
Copied to your clipboard
ACPAnalytics.setVisitorIdentifier(visitorIdentifier, success, fail);

• visitorIdentifier is the new value for the visitor identifier.
• success is a callback containing a general success message if the setVisitorIdentifier API executed without any errors.
• fail is a callback containing error information if the setVisitorIdentifier API was executed with errors.

Example

Copy
ACPAnalytics.setVisitorIdentifier("custom_identifier", function (handleCallback) {
  console.log("AdobeExperienceSDK: Custom visitor identifier set successfully. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to set custom visitor identifier: " + handleError);
});
Copied to your clipboard
ACPAnalytics.setVisitorIdentifier("custom_identifier", function (handleCallback) {
  console.log("AdobeExperienceSDK: Custom visitor identifier set successfully. " + handleCallback);
} ,function (handleError) {
  console.log("AdobeExperenceSDK: Failed to set custom visitor identifier: " + handleError);
});

C#

Syntax

Copy
public static void SetVisitorIdentifier(string visitorId)
Copied to your clipboard
public static void SetVisitorIdentifier(string visitorId)

• visitorId is the new value for the visitor identifier.

Example

Copy
ACPAnalytics.SetVisitorIdentifier("VisitorIdentifier");
Copied to your clipboard
ACPAnalytics.SetVisitorIdentifier("VisitorIdentifier");

C#

iOS

Syntax

Copy
public static void SetVisitorIdentifier (string visitorIdentifier);
Copied to your clipboard
public static void SetVisitorIdentifier (string visitorIdentifier);

• visitorIdentifier is the new value for the visitor identifier.

Android

Syntax

Copy
public unsafe static void SetVisitorIdentifier (string visitorID);
Copied to your clipboard
public unsafe static void SetVisitorIdentifier (string visitorID);

• visitorID is the new value for the visitor identifier.

Example

Copy
ACPAnalytics.SetVisitorIdentifier("VisitorIdentifier");
Copied to your clipboard
ACPAnalytics.SetVisitorIdentifier("VisitorIdentifier");