Class: Manager

Manager

new Manager(options)

Parameters:
Name Type Description
options AMA.Client.Options | AMA.Client A configuration map for the AMA.Client or an instantiated AMA.Client
Source:
See:

Methods

createEvent(eventType, attributes=, metrics=) → {AMA.Client.Event}

Function that constructs a Mobile Analytics Event
Parameters:
Name Type Argument Description
eventType string Custom Event Type to be displayed in Console
attributes= AMA.Client.Attributes <optional>
 Map of String attributes
metrics= AMA.Client.Metrics <optional>
 Map of numeric values
Source:
Returns:
Type
AMA.Client.Event

extendSession(milliseconds) → {int}

Function to extend the current session.
Parameters:
Name Type Argument Default Description
milliseconds int <optional>
 options.sessionLength Milliseconds to extend the session by, will default to another session length
Source:
Returns:
The Session expiration (in Milliseconds)
Type
int

recordEvent(eventType, attributes=, metrics=) → {AMA.Client.Event}

Function to record a custom event
Parameters:
Name Type Argument Description
eventType Custom event type name
attributes= AMA.Client.Attributes <optional>
 Custom attributes
metrics= AMA.Client.Metrics <optional>
 Custom metrics
Source:
Returns:
The event that was recorded
Type
AMA.Client.Event

recordMonetizationEvent(monetizationDetails, attributes=, metrics=) → {AMA.Client.Event}

Function to record a monetization event
Parameters:
Name Type Argument Description
monetizationDetails Object Details about Monetization Event
Properties
Name Type Description
currency string ISO Currency of event
productId string Product Id of monetization event
quantity number Quantity of product in transaction
price string | number Price of product either ISO formatted string, or number with associated ISO Currency
attributes= AMA.Client.Attributes <optional>
 Custom attributes
metrics= AMA.Client.Metrics <optional>
 Custom metrics
Source:
Returns:
The event that was recorded
Type
AMA.Client.Event

renewSession() → {AMA.Session}

Function to stop the current session and start a new one
Source:
Returns:
The new Session Object for the SessionManager
Type
AMA.Session

startSession() → {AMA.Client.Event}

Function to start a session
Source:
Returns:
The start session event recorded
Type
AMA.Client.Event

stopSession() → {AMA.Client.Event}

Function to stop the current session
Source:
Returns:
The stop session event recorded
Type
AMA.Client.Event

submitEvents(options=) → {Array}

submitEvents
Parameters:
Name Type Argument Default Description
options= Object <optional>
 options for submitting events
options.clientContext Object <optional>
 this.options.clientContext clientContext to submit with defaults to options.clientContext
Source:
Returns:
Array of batch indices that were submitted
Type
Array

Type Definitions

Options

Properties:
Name Type Argument Description
expirationCallback= AMA.Session.ExpirationCallback <optional>
 Callback function to call when sessions expire
Source: