lifecycleStart

lifecycleStart

Contains constants and functions for a Lifecycle Start.

The structure for a Lifecycle Start is as follows:

{
  payload: {
    ACPExtensionEventData: {
      maxsessionlength: <integer>,
      sessionevent: <string>,
      lifecyclecontextdata: {
        appid: <string>,
        launches: <string>,
        crashevent: <string>,
        devicename: <string>,
        hourofday: <string>,
        dayssincelastuse: <string>,
        runmode: <string>,
        previousosversion: <string>,
        locale: <string>,
        carriername: <string>,
        dayssincefirstuse: <string>,
        dayofweek: <string>,
        launchevent: <string>,
        previousappid: <string>,
        resolution: <string>,
        ignoredsessionlength: <string>,
        osversion: <string>,
      },
      starttimestampseconds: <number>,
      previoussessionpausetimestampseconds: <number>,
      previoussessionstarttimestampseconds: <number>,
    },
    ACPExtensionEventSource: 'com.adobe.eventsource.responsecontent'
    ACPExtensionEventType: 'com.adobe.eventtype.lifecycle'
    ACPExtensionEventName: <string>,
    ACPExtensionEventNumber: <integer>,
    ACPExtensionEventUniqueIdentifier: <string>,
  },
  type: 'generic'
  vendor: <string>,
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) EVENT_SOURCE

The value for eventSource for a Lifecycle Start.

Path is payload,ACPExtensionEventSource.

Source:

(static, constant) EVENT_TYPE

The value for eventType for a Lifecycle Start.

Path is payload,ACPExtensionEventType.

Source:

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Lifecycle Start objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Lifecycle Start

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
eventData string

The lifecycle data.
Path is payload.ACPExtensionEventData.
maxSessionLength string

The amount of time before a session expires.
Path is payload.ACPExtensionEventData.maxsessionlength.
sessionEvent string

The type of event that triggers the new session.
Path is payload.ACPExtensionEventData.sessionevent.
contextData string

Context data about the device.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.
appId string

The id of the application.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.appid.
launches string

The number of times the app has launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.launches.
crashEvent string

The name of the applications crash event.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.crashevent.
deviceName string

The name of device.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.devicename.
hourOfDay string

The hour in the day that the app launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.hourofday.
daysSinceLastUse string

Number of days since the app was last launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.dayssincelastuse.
runMode string

Type of application format. Will change if on a smart device..
Path is payload.ACPExtensionEventData.lifecyclecontextdata.runmode.
previousOsVersion string

The version of the OS the last time the app launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.previousosversion.
locale string

The language the device is running under.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.locale.
carrierName string

The phone provider the device goes through.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.carriername.
daysSinceFirstUse string

The number of days since the first launch of the application.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.dayssincefirstuse.
dayOfWeek string

The day of week that the app launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.dayofweek.
launchEvent string

The name of the application launch event.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.launchevent.
previousAppId string

The id of the application the last time the app was launched.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.previousappid.
resolution string

The resolution of the device.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.resolution.
ignoredSessionLength string

Used in calculdating length of session.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.ignoredsessionlength.
osVersion string

The version of the OS.
Path is payload.ACPExtensionEventData.lifecyclecontextdata.osversion.
startTimestamp string

The timestamp when the session started.
Path is payload.ACPExtensionEventData.starttimestampseconds.
previousSessionPauseTimestamp string

The timestamp when the previous session was paused (if applicable).
Path is payload.ACPExtensionEventData.previoussessionpausetimestampseconds.
previousSessionStartTimestamp string

The timestamp when the previous session was started.
Path is payload.ACPExtensionEventData.previoussessionstarttimestampseconds.
eventSource string

The event source.
Path is payload.ACPExtensionEventSource.
eventType string

The event type.
Path is payload.ACPExtensionEventType.
eventName string

The name of the event.
Path is payload.ACPExtensionEventName.
sdkEventNumber string

The event number generated by the SDK.
Path is payload.ACPExtensionEventNumber.
eventId string

The unique event id.
Path is payload.ACPExtensionEventUniqueIdentifier.
rootType string

The type of event.
Path is type.
vendor string

The vendor of the plugin that sent the event.
Path is vendor.
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Lifecycle Start.

Path is type.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getAppId(source) → {string}

Returns the appId from the Lifecycle Start. This is the the id of the application.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,appid.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getCarrierName(source) → {string}

Returns the carrierName from the Lifecycle Start. This is the the phone provider the device goes through.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,carriername.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getContextData(source) → {object}

Returns the contextData from the Lifecycle Start. This is the context data about the device.

Path is payload,ACPExtensionEventData,lifecyclecontextdata.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getContextDataKey(…path, source) → {*}

Returns the data using the specified path from the contextData of the Lifecycle Start.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Lifecycle Start instance
Source:

(static) getCrashEvent(source) → {string}

Returns the crashEvent from the Lifecycle Start. This is the the name of the applications crash event.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,crashevent.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getDayOfWeek(source) → {string}

Returns the dayOfWeek from the Lifecycle Start. This is the the day of week that the app launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,dayofweek.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getDaysSinceFirstUse(source) → {string}

Returns the daysSinceFirstUse from the Lifecycle Start. This is the the number of days since the first launch of the application.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,dayssincefirstuse.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getDaysSinceLastUse(source) → {string}

Returns the daysSinceLastUse from the Lifecycle Start. This is the number of days since the app was last launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,dayssincelastuse.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getDeviceName(source) → {string}

Returns the deviceName from the Lifecycle Start. This is the the name of device.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,devicename.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getHourOfDay(source) → {string}

Returns the hourOfDay from the Lifecycle Start. This is the the hour in the day that the app launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,hourofday.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getIgnoredSessionLength(source) → {string}

Returns the ignoredSessionLength from the Lifecycle Start. This is the used in calculdating length of session.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,ignoredsessionlength.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getLaunches(source) → {string}

Returns the launches from the Lifecycle Start. This is the the number of times the app has launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,launches.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getLaunchEvent(source) → {string}

Returns the launchEvent from the Lifecycle Start. This is the the name of the application launch event.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,launchevent.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getLocale(source) → {string}

Returns the locale from the Lifecycle Start. This is the the language the device is running under.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,locale.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getMaxSessionLength(source) → {number}

Returns the maxSessionLength from the Lifecycle Start. This is the the amount of time before a session expires.

Path is payload,ACPExtensionEventData,maxsessionlength.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getOsVersion(source) → {string}

Returns the osVersion from the Lifecycle Start. This is the the version of the OS.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,osversion.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getPreviousAppId(source) → {string}

Returns the previousAppId from the Lifecycle Start. This is the the id of the application the last time the app was launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,previousappid.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getPreviousOsVersion(source) → {string}

Returns the previousOsVersion from the Lifecycle Start. This is the the version of the OS the last time the app launched.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,previousosversion.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getPreviousSessionPauseTimestamp(source) → {number}

Returns the previousSessionPauseTimestamp from the Lifecycle Start. This is the the timestamp when the previous session was paused (if applicable).

Path is payload,ACPExtensionEventData,previoussessionpausetimestampseconds.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getPreviousSessionStartTimestamp(source) → {number}

Returns the previousSessionStartTimestamp from the Lifecycle Start. This is the the timestamp when the previous session was started.

Path is payload,ACPExtensionEventData,previoussessionstarttimestampseconds.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getResolution(source) → {string}

Returns the resolution from the Lifecycle Start. This is the the resolution of the device.

Path is payload,ACPExtensionEventData,lifecyclecontextdata,resolution.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getRunMode(source) → {string}

Returns the runMode from the Lifecycle Start. This is the type of application format. Will change if on a smart device..

Path is payload,ACPExtensionEventData,lifecyclecontextdata,runmode.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getSessionEvent(source) → {string}

Returns the sessionEvent from the Lifecycle Start. This is the the type of event that triggers the new session.

Path is payload,ACPExtensionEventData,sessionevent.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) getStartTimestamp(source) → {number}

Returns the startTimestamp from the Lifecycle Start. This is the the timestamp when the session started.

Path is payload,ACPExtensionEventData,starttimestampseconds.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Lifecycle Start event.

Parameters:
Name Type Description
source object

The Lifecycle Start instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Lifecycle Start with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Lifecycle Start with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: