mobileEvent

mobileEvent

Contains constants and functions for a Generic Mobile Event.

The structure for a Generic Mobile Event is as follows:

{
  payload: {
    ACPExtensionEventData: <object>,
    ACPExtensionEventName: <string>,
    ACPExtensionEventNumber: <integer>,
    ACPExtensionEventSource: <string>,
    ACPExtensionEventType: <string>,
    ACPExtensionEventUniqueIdentifier: <string>,
  },
  type: 'generic'
  vendor: <string>,
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(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 Generic Mobile Event 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 Generic Mobile Event

Properties:
Name Type Description
payload string

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

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

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

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

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

The event type.
Path is payload.ACPExtensionEventType.
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 Generic Mobile Event.

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) getEventData(source) → {object}

Returns the eventData from the Generic Mobile Event. This is the an object with the custom data describing the event.

Path is payload,ACPExtensionEventData.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

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

Returns the data using the specified path from the eventData of the Generic Mobile Event.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Generic Mobile Event instance
Source:

(static) getEventId(source) → {string}

Returns the eventId from the Generic Mobile Event. This is the the unique event id.

Path is payload,ACPExtensionEventUniqueIdentifier.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) getEventName(source) → {string}

Returns the eventName from the Generic Mobile Event. This is the the name of the event.

Path is payload,ACPExtensionEventName.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) getEventSource(source) → {string}

Returns the eventSource from the Generic Mobile Event. This is the the event source.

Path is payload,ACPExtensionEventSource.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) getEventType(source) → {string}

Returns the eventType from the Generic Mobile Event. This is the the event type.

Path is payload,ACPExtensionEventType.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) getSdkEventNumber(source) → {number}

Returns the sdkEventNumber from the Generic Mobile Event. This is the the event number generated by the SDK.

Path is payload,ACPExtensionEventNumber.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) getVendor(source) → {string}

Returns the vendor from the Generic Mobile Event. This is the the vendor of the plugin that sent the event.

Path is vendor.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Generic Mobile Event event.

Parameters:
Name Type Description
source object

The Generic Mobile Event instance
Source:
See:
  • kit.isMatch

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

Generates a Generic Mobile Event 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 Generic Mobile Event 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: