PWAnalytics Class Reference
| Inherits from | NSObject |
| Declared in | PWAnalytics.h |
Overview
PWAnalytics enables easy implementation of application workflow analytics. MaaSAnalytics supports standard analytics events, timed events and event parameters.
Tasks
Event Methods
-
+ addEvent: -
+ addEvent:eventNamespace: -
+ addEvent:withParameters: -
+ addEvent:withParameters:eventNamespace: -
+ startTimedEvent: -
+ startTimedEvent:eventNamespace: -
+ startTimedEvent:withParameters: -
+ startTimedEvent:withParameters:eventNamespace: -
+ pauseTimedEvent: -
+ resumeTimedEvent: -
+ endTimedEvent: -
+ endTimedEvent:withParameters: -
+ endTimedEvent:withParameters:eventNamespace:
Other Methods
Class Methods
addEvent:
Add an event to the analytics queue.
+ (void)addEvent:(NSString *__nonnull)eventNameParameters
- eventName
Name of the event.
Declared In
PWAnalytics.haddEvent:eventNamespace:
Add an event to the analytics queue.
+ (void)addEvent:(NSString *__nonnull)eventName eventNamespace:(NSString *__nonnull)eventNamespaceParameters
- eventName
Name of the event.
- eventNamespace
The namespace of the analytic event. Used for custom event processing.
Declared In
PWAnalytics.haddEvent:withParameters:
Add an event to the analytics queue. Parameters must follow these rules:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)addEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parametersParameters
- eventName
Name of the event.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
Declared In
PWAnalytics.haddEvent:withParameters:eventNamespace:
Add an event to the analytics queue. Parameters must follow these rules:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)addEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parameters eventNamespace:(NSString *__nullable)eventNamespaceParameters
- eventName
Name of the event.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
- eventNamespace
The namespace of the analytic event. Used for custom event processing.
Declared In
PWAnalytics.hendTimedEvent:
End a timed event with the specified eventName. The event will be ignored if the event duration is less than one second. This method will do nothing if the event name cannot be found.
+ (void)endTimedEvent:(NSString *__nonnull)eventNameParameters
- eventName
The name of the event to end.
Declared In
PWAnalytics.hendTimedEvent:withParameters:
End a timed event with the specified eventName. The event will be ignored if the event duration is less than one second. This method will do nothing if the event name cannot be found. Parameters must follow these rules:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)endTimedEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parametersParameters
- eventName
The name of the event to end.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
Declared In
PWAnalytics.hendTimedEvent:withParameters:eventNamespace:
End a timed event with the specified eventName. The event will be ignored if the event duration is less than one second. This method will do nothing if the event name cannot be found. Parameters must follow these rules:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)endTimedEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parameters eventNamespace:(NSString *__nullable)eventNamespaceParameters
- eventName
The name of the event to end.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
- eventNamespace
The namespace of the analytic event. Used for custom event processing.
Declared In
PWAnalytics.hpauseTimedEvent:
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, this method will do nothing.
+ (void)pauseTimedEvent:(NSString *__nonnull)eventNameParameters
- eventName
The name of the event to pause.
Declared In
PWAnalytics.hresumeTimedEvent:
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, this method will do nothing.
+ (void)resumeTimedEvent:(NSString *__nonnull)eventNameParameters
- eventName
The name of the event to resume.
Declared In
PWAnalytics.hstartTimedEvent:
Start a timed event. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time.
+ (void)startTimedEvent:(NSString *__nonnull)eventNameParameters
- eventName
Name of the event to start.
Declared In
PWAnalytics.hstartTimedEvent:eventNamespace:
Start a timed event. Calling startTimedEvent: with the same eventName prior to endTimedEvent: will overwrite the previous start time.
+ (void)startTimedEvent:(NSString *__nonnull)eventName eventNamespace:(NSString *__nullable)eventNamespaceParameters
- eventName
Name of the event to start.
- eventNamespace
The namespace of the analytic event. Used for custom event processing.
Declared In
PWAnalytics.hstartTimedEvent: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:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)startTimedEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parametersParameters
- eventName
Name of the event to start.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
Declared In
PWAnalytics.hstartTimedEvent:withParameters:eventNamespace:
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:
(1) Keys and values must be NSString objects.
(2) There may be no more than 10 parameters. Extra parameters will be ignored.
(3) Each key or value that is longer than 256 characters will be truncated.
+ (void)startTimedEvent:(NSString *__nonnull)eventName withParameters:(NSDictionary *__nullable)parameters eventNamespace:(NSString *__nullable)eventNamespaceParameters
- eventName
Name of the event to start.
- parameters
NSStringkey / value parameters. For example,@{@"key" : @"value"}.
- eventNamespace
The namespace of the analytic event. Used for custom event processing.
Declared In
PWAnalytics.h