Inherits from NSObject
Declared in MaaSAnalytics.h

Overview

MaaSAnalytics enables easy implementation of application workflow analytics. MaaSAnalytics supports standard analytics events, timed events, and event parameters.

Tasks

Event Methods

  • + addEvent:

    Add an event to the analytics queue.

  • + addEvent:withParameters:

    Add an event to the analytics queue. Parameters must follow these rules: – Keys and values must be NSString objects. – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

  • + startTimedEvent:

    Start a timed event. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time.

  • + startTimedEvent:withParameters:

    Start a timed event with the specified parameters. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time. Parameters must follow these rules: – Keys and values must be NSString objects – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

  • + pauseTimedEvent:

    Pause a timed event with the specified eventName. If an event is ended while still in a paused state then the paused time will be used as the end time. If an event is already paused then this method will do nothing.

  • + resumeTimedEvent:

    Resume a timed event with the specified eventName. If an event is ended while still in a paused state then the paused time will be used as the end time. If an event is already paused then this method will do nothing.

  • + endTimedEvent:

    End a timed event with the specified eventName. The event will be ignored if the event duration is less than 1 second. This method will do nothing if the event name cannot be found.

  • + endTimedEvent:withParameters:

    End a timed event with the specified eventName. The event will be ignored if the event duration is less than 1 second. This method will do nothing if the event name cannot be found. Parameters must follow these rules: – Keys and values must be NSString objects – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

Other Methods

Class Methods

addEvent:

Add an event to the analytics queue.

+ (void)addEvent:(NSString *)eventName

Parameters

eventName

Name of the event. The eventName must be alphanumeric.

Declared In

MaaSAnalytics.h

addEvent:withParameters:

Add an event to the analytics queue. Parameters must follow these rules: – Keys and values must be NSString objects. – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

+ (void)addEvent:(NSString *)eventName withParameters:(NSDictionary *)parameters

Parameters

eventName

Name of the event. The eventName must be alphanumeric.

parameters

NSString key/value parameters. For example, @{@"key" : @"value"}. The key and values must be alphanumeric.

Declared In

MaaSAnalytics.h

endTimedEvent:

End a timed event with the specified eventName. The event will be ignored if the event duration is less than 1 second. This method will do nothing if the event name cannot be found.

+ (void)endTimedEvent:(NSString *)eventName

Parameters

eventName

The name of the event to end. The eventName must be alphanumeric.

Declared In

MaaSAnalytics.h

endTimedEvent:withParameters:

End a timed event with the specified eventName. The event will be ignored if the event duration is less than 1 second. This method will do nothing if the event name cannot be found. Parameters must follow these rules: – Keys and values must be NSString objects – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

+ (void)endTimedEvent:(NSString *)eventName withParameters:(NSDictionary *)parameters

Parameters

eventName

The name of the event to end. The eventName must be alphanumeric.

parameters

NSString key/value parameters. For example, @{@"key" : @"value"}. The key and values must be alphanumeric.

Declared In

MaaSAnalytics.h

pauseTimedEvent:

Pause a timed event with the specified eventName. If an event is ended while still in a paused state then the paused time will be used as the end time. If an event is already paused then this method will do nothing.

+ (void)pauseTimedEvent:(NSString *)eventName

Parameters

eventName

The name of the event to pause. The eventName must be alphanumeric.

Declared In

MaaSAnalytics.h

resumeTimedEvent:

Resume a timed event with the specified eventName. If an event is ended while still in a paused state then the paused time will be used as the end time. If an event is already paused then this method will do nothing.

+ (void)resumeTimedEvent:(NSString *)eventName

Parameters

eventName

The name of the event to resume. The eventName must be alphanumeric.

Declared In

MaaSAnalytics.h

serviceName

Returns ‘MaaSAnalytics’.

+ (NSString *)serviceName

Declared In

MaaSAnalytics.h

startTimedEvent:

Start a timed event. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time.

+ (void)startTimedEvent:(NSString *)eventName

Parameters

eventName

Name of the event to start.

Declared In

MaaSAnalytics.h

startTimedEvent:withParameters:

Start a timed event with the specified parameters. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time. Parameters must follow these rules: – Keys and values must be NSString objects – There may be no more than 10 parameters. Extra parameters will be ignored – Each key or value that is longer than 256 characters will be truncated

+ (void)startTimedEvent:(NSString *)eventName withParameters:(NSDictionary *)parameters

Parameters

eventName

Name of the event to start. The eventName must be alphanumeric.

parameters

NSString key/value parameters. For example, @{@"key" : @"value"}. The key and values must be alphanumeric.

Declared In

MaaSAnalytics.h