Lifecycle 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

The extensionVersion() API returns the version of the Lifecycle extension that is registered with the Mobile Core extension.

To get the version of the Lifecycle extension, use the following code sample:

Android

Java

String lifecycleExtensionVersion = Lifecycle.extensionVersion();
Copied to your clipboard
String lifecycleExtensionVersion = Lifecycle.extensionVersion();

iOS

Swift

let lifecycleExtensionVersion  = ACPLifecycle.extensionVersion()
Copied to your clipboard
let lifecycleExtensionVersion  = ACPLifecycle.extensionVersion()

Objective-C

NSString *lifecycleExtensionVersion = [ACPLifecycle extensionVersion];
Copied to your clipboard
NSString *lifecycleExtensionVersion = [ACPLifecycle extensionVersion];

React Native

JavaScript

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

Flutter

Dart

String lifeycycleExtensionVersion = await FlutterACPLifecycle.extensionVersion;
Copied to your clipboard
String lifeycycleExtensionVersion = await FlutterACPLifecycle.extensionVersion;

Cordova

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

Unity

string lifecycleVersion = ACPLifecycle.ExtensionVersion();
Copied to your clipboard
string lifecycleVersion = ACPLifecycle.ExtensionVersion();

Xamarin

string lifecycleVersion = ACPLifecycle.ExtensionVersion();
Copied to your clipboard
string lifecycleVersion = ACPLifecycle.ExtensionVersion();

Java

String lifecycleExtensionVersion = Lifecycle.extensionVersion();
Copied to your clipboard
String lifecycleExtensionVersion = Lifecycle.extensionVersion();

Swift

let lifecycleExtensionVersion  = ACPLifecycle.extensionVersion()
Copied to your clipboard
let lifecycleExtensionVersion  = ACPLifecycle.extensionVersion()

Objective-C

NSString *lifecycleExtensionVersion = [ACPLifecycle extensionVersion];
Copied to your clipboard
NSString *lifecycleExtensionVersion = [ACPLifecycle extensionVersion];

JavaScript

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

Dart

String lifeycycleExtensionVersion = await FlutterACPLifecycle.extensionVersion;
Copied to your clipboard
String lifeycycleExtensionVersion = await FlutterACPLifecycle.extensionVersion;

Cordova

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

string lifecycleVersion = ACPLifecycle.ExtensionVersion();
Copied to your clipboard
string lifecycleVersion = ACPLifecycle.ExtensionVersion();

string lifecycleVersion = ACPLifecycle.ExtensionVersion();
Copied to your clipboard
string lifecycleVersion = ACPLifecycle.ExtensionVersion();

lifecycleStart

Starts the collection of lifecycle data.

For Analytics use case: Use this API to start a new lifecycle session or resume a previously paused lifecycle session. If a previously paused session timed out, then a new session is created. If a current session is running, then calling this method does nothing.

Android

Java

This method should be called from the Activity onResume method.

Syntax

public static void lifecycleStart(final Map<String, String> additionalContextData);
Copied to your clipboard
public static void lifecycleStart(final Map<String, String> additionalContextData);

Example

MobileCore.lifecycleStart(null);
Copied to your clipboard
MobileCore.lifecycleStart(null);

If you need to collect additional lifecycle data:

contextData.put("myapp.category", "Game");
MobileCore.lifecycleStart(additionalContextData);
Copied to your clipboard
contextData.put("myapp.category", "Game");
MobileCore.lifecycleStart(additionalContextData);

iOS

Swift

ACPCore.lifecycleStart(["state": "appResume"])
Copied to your clipboard
ACPCore.lifecycleStart(["state": "appResume"])

Objective-C

Syntax

+ (void) lifecycleStart: (nullable NSDictionary<NSString*, NSString*>*) additionalContextData;
Copied to your clipboard
+ (void) lifecycleStart: (nullable NSDictionary<NSString*, NSString*>*) additionalContextData;

Example

[ACPCore lifecycleStart:nil];
Copied to your clipboard
[ACPCore lifecycleStart:nil];

If you need to collect additional lifecycle data:

[ACPCore lifecycleStart:@{@"state": @"appResume"}];
Copied to your clipboard
[ACPCore lifecycleStart:@{@"state": @"appResume"}];

React Native

Cordova

Unity

C#

When using Unity, the LifecycleStart method call must be made from the OnApplicationPause method.

private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}
Copied to your clipboard
private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}

Xamarin

C#

iOS

When using iOS, the LifecycleStart method call must be made from the OnActivated method.

public override void OnActivated(UIApplication uiApplication)
{
  base.OnActivated(uiApplication);
  ACPCore.LifecycleStart(null);
}
Copied to your clipboard
public override void OnActivated(UIApplication uiApplication)
{
  base.OnActivated(uiApplication);
  ACPCore.LifecycleStart(null);
}

Android

When using Android, the LifecycleStart method call must be made from the OnResume method.

protected override void OnResume()
{
  base.OnResume();
  ACPCore.LifecycleStart(null);
}
Copied to your clipboard
protected override void OnResume()
{
  base.OnResume();
  ACPCore.LifecycleStart(null);
}

Java

This method should be called from the Activity onResume method.

Syntax

public static void lifecycleStart(final Map<String, String> additionalContextData);
Copied to your clipboard
public static void lifecycleStart(final Map<String, String> additionalContextData);

Example

MobileCore.lifecycleStart(null);
Copied to your clipboard
MobileCore.lifecycleStart(null);

If you need to collect additional lifecycle data:

contextData.put("myapp.category", "Game");
MobileCore.lifecycleStart(additionalContextData);
Copied to your clipboard
contextData.put("myapp.category", "Game");
MobileCore.lifecycleStart(additionalContextData);

Swift

ACPCore.lifecycleStart(["state": "appResume"])
Copied to your clipboard
ACPCore.lifecycleStart(["state": "appResume"])

Objective-C

Syntax

+ (void) lifecycleStart: (nullable NSDictionary<NSString*, NSString*>*) additionalContextData;
Copied to your clipboard
+ (void) lifecycleStart: (nullable NSDictionary<NSString*, NSString*>*) additionalContextData;

Example

[ACPCore lifecycleStart:nil];
Copied to your clipboard
[ACPCore lifecycleStart:nil];

If you need to collect additional lifecycle data:

[ACPCore lifecycleStart:@{@"state": @"appResume"}];
Copied to your clipboard
[ACPCore lifecycleStart:@{@"state": @"appResume"}];

C#

When using Unity, the LifecycleStart method call must be made from the OnApplicationPause method.

private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}
Copied to your clipboard
private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}

C#

iOS

When using iOS, the LifecycleStart method call must be made from the OnActivated method.

public override void OnActivated(UIApplication uiApplication)
{
  base.OnActivated(uiApplication);
  ACPCore.LifecycleStart(null);
}
Copied to your clipboard
public override void OnActivated(UIApplication uiApplication)
{
  base.OnActivated(uiApplication);
  ACPCore.LifecycleStart(null);
}

Android

When using Android, the LifecycleStart method call must be made from the OnResume method.

protected override void OnResume()
{
  base.OnResume();
  ACPCore.LifecycleStart(null);
}
Copied to your clipboard
protected override void OnResume()
{
  base.OnResume();
  ACPCore.LifecycleStart(null);
}

lifecyclePause

Pauses the collection of lifecycle data.

For Analytics use case: Use this API to pause the collection of lifecycle data.

Android

Java

Syntax

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

Example

MobileCore.lifecyclePause();
Copied to your clipboard
MobileCore.lifecyclePause();

iOS

Swift

ACPCore.lifecyclePause()
Copied to your clipboard
ACPCore.lifecyclePause()

Objective-C

Syntax

+ (void) lifecyclePause;
Copied to your clipboard
+ (void) lifecyclePause;

Example

[ACPCore lifecyclePause];
Copied to your clipboard
[ACPCore lifecyclePause];

React Native

Cordova

Unity

C#

When using Unity, the LifecyclePause method call must be made from the OnApplicationPause method.

private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}
Copied to your clipboard
private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}

Xamarin

C#

iOS

When using iOS, the LifecyclePause method call must be made from the OnResignActivation method.

public override void OnResignActivation(UIApplication uiApplication)
{
  base.OnResignActivation(uiApplication);
  ACPCore.LifecyclePause();
}
Copied to your clipboard
public override void OnResignActivation(UIApplication uiApplication)
{
  base.OnResignActivation(uiApplication);
  ACPCore.LifecyclePause();
}

Android

When using Android, the LifecyclePause method call must be made from the OnPause method.

protected override void OnPause()
{
  base.OnPause();
  ACPCore.LifecyclePause();
}
Copied to your clipboard
protected override void OnPause()
{
  base.OnPause();
  ACPCore.LifecyclePause();
}

Java

Syntax

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

Example

MobileCore.lifecyclePause();
Copied to your clipboard
MobileCore.lifecyclePause();

Swift

ACPCore.lifecyclePause()
Copied to your clipboard
ACPCore.lifecyclePause()

Objective-C

Syntax

+ (void) lifecyclePause;
Copied to your clipboard
+ (void) lifecyclePause;

Example

[ACPCore lifecyclePause];
Copied to your clipboard
[ACPCore lifecyclePause];

C#

When using Unity, the LifecyclePause method call must be made from the OnApplicationPause method.

private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}
Copied to your clipboard
private void OnApplicationPause(bool pauseStatus)
{
  if (!pauseStatus)
  {
    ACPCore.LifecyclePause();
  }
  else
  {
    var cdata = new Dictionary<string, string>();
    cdata.Add("launch.data", "added");
    ACPCore.LifecycleStart(cdata);
  }
}

C#

iOS

When using iOS, the LifecyclePause method call must be made from the OnResignActivation method.

public override void OnResignActivation(UIApplication uiApplication)
{
  base.OnResignActivation(uiApplication);
  ACPCore.LifecyclePause();
}
Copied to your clipboard
public override void OnResignActivation(UIApplication uiApplication)
{
  base.OnResignActivation(uiApplication);
  ACPCore.LifecyclePause();
}

Android

When using Android, the LifecyclePause method call must be made from the OnPause method.

protected override void OnPause()
{
  base.OnPause();
  ACPCore.LifecyclePause();
}
Copied to your clipboard
protected override void OnPause()
{
  base.OnPause();
  ACPCore.LifecyclePause();
}

Overview

Migration

Was this helpful?

Yes

Lifecycle API reference

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

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

Java

lifecycleStart

Java

Swift

Objective-C

JavaScript

Cordova

C#

C#

Java

Swift

Objective-C

JavaScript

Cordova

C#

C#

lifecyclePause

Java

Swift

Objective-C

JavaScript

Cordova

C#

C#

Java

Swift

Objective-C

JavaScript

Cordova

C#

C#

extensionVersion

Java