#import <PFAnalytics.h>

Inheritance diagram for PFAnalytics:

Class Methods
(BFTask< NSNumber * > *)	+ trackAppOpenedWithLaunchOptions:
	More...

(void)	+ trackAppOpenedWithLaunchOptionsInBackground:block:

(BFTask< NSNumber * > *)	+ trackAppOpenedWithRemoteNotificationPayload:

(void)	+ trackAppOpenedWithRemoteNotificationPayloadInBackground:block:

(BFTask< NSNumber * > *)	+ trackEvent:
	More...

(void)	+ trackEventInBackground:block:


(BFTask< NSNumber * > *)	+ trackEvent:dimensions:

(void)	+ trackEventInBackground:dimensions:block:

Detailed Description

This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory. PFAnalytics provides an interface to Parse's logging and analytics backend.

Methods will return immediately and cache the request (+ timestamp) to be handled "eventually." That is, the request will be sent immediately if possible or the next time a network connection is available.

Method Documentation

+ (BFTask<NSNumber *> *) trackAppOpenedWithLaunchOptions: (nullable NSDictionary *) launchOptions

Tracks this application being launched. If this happened as the result of the user opening a push notification, this method sends along information to correlate this open with that push.

Pass in nil to track a standard "application opened" event.

Parameters

launchOptions The NSDictionary indicating the reason the application was launched, if any. This value can be found as a parameter to various UIApplicationDelegate methods, and can be empty or nil.

Returns: Returns the task encapsulating the work being done.

+ (void) trackAppOpenedWithLaunchOptionsInBackground:	(nullable NSDictionary *)	launchOptions
block:	(nullable PFBooleanResultBlock)	block

Tracks this application being launched. If this happened as the result of the user opening a push notification, this method sends along information to correlate this open with that push.

Pass in nil to track a standard "application opened" event.

Parameters

launchOptions	The dictionary indicating the reason the application was launched, if any. This value can be found as a parameter to various `UIApplicationDelegate` methods, and can be empty or `nil`.
block	The block to execute on server response. It should have the following argument signature: `^(BOOL succeeded, NSError *error)`

+ (BFTask<NSNumber *> *) trackAppOpenedWithRemoteNotificationPayload: (nullable NSDictionary *) userInfo

Tracks this application being launched. If this happened as the result of the user opening a push notification, this method sends along information to correlate this open with that push.

Parameters

userInfo The Remote Notification payload, if any. This value can be found either under UIApplicationLaunchOptionsRemoteNotificationKey on launchOptions, or as a parameter to application:didReceiveRemoteNotification:. This can be empty or nil.

Returns: Returns the task encapsulating the work being done.

+ (void) trackAppOpenedWithRemoteNotificationPayloadInBackground:	(nullable NSDictionary *)	userInfo
block:	(nullable PFBooleanResultBlock)	block

Tracks this application being launched. If this happened as the result of the user opening a push notification, this method sends along information to correlate this open with that push.

Parameters

userInfo	The Remote Notification payload, if any. This value can be found either under `UIApplicationLaunchOptionsRemoteNotificationKey` on `launchOptions`, or as a parameter to `application:didReceiveRemoteNotification:`. This can be empty or `nil`.
block	The block to execute on server response. It should have the following argument signature: `^(BOOL succeeded, NSError *error)`

+ (BFTask<NSNumber *> *) trackEvent: (NSString *) name

Tracks the occurrence of a custom event.

Parse will store a data point at the time of invocation with the given event name.

Parameters

name	The name of the custom event to report to Parse as having happened.

Returns: Returns the task encapsulating the work being done.

+ (BFTask<NSNumber > ) trackEvent:	(NSString *)	name
dimensions:	(nullable NSDictionary< NSString , NSString > *)	dimensions

Tracks the occurrence of a custom event with additional dimensions. Parse will store a data point at the time of invocation with the given event name.

Dimensions will allow segmentation of the occurrences of this custom event. Keys and values should be NSStrings, and will throw otherwise.

To track a user signup along with additional metadata, consider the following:

NSDictionary *dimensions = "gender": @"m", @"source": @"web", @"dayType": @"weekend" }; [PFAnalytics trackEvent:@"signup" dimensions:dimensions];

Warning: There is a default limit of 8 dimensions per event tracked.

Parameters

name	The name of the custom event to report to Parse as having happened.
dimensions	The `NSDictionary` of information by which to segment this event.

Returns: Returns the task encapsulating the work being done.

+ (void) trackEventInBackground:	(NSString *)	name
block:	(nullable PFBooleanResultBlock)	block

Tracks the occurrence of a custom event. Parse will store a data point at the time of invocation with the given event name. The event will be sent at some unspecified time in the future, even if Parse is currently inaccessible.

Parameters

name	The name of the custom event to report to Parse as having happened.
block	The block to execute on server response. It should have the following argument signature: `^(BOOL succeeded, NSError *error)`

+ (void) trackEventInBackground:	(NSString *)	name
dimensions:	(nullable NSDictionary< NSString , NSString > *)	dimensions
block:	(nullable PFBooleanResultBlock)	block

Tracks the occurrence of a custom event with additional dimensions. Parse will store a data point at the time of invocation with the given event name. The event will be sent at some unspecified time in the future, even if Parse is currently inaccessible.

Dimensions will allow segmentation of the occurrences of this custom event. Keys and values should be NSStrings, and will throw otherwise.

To track a user signup along with additional metadata, consider the following: NSDictionary *dimensions = "gender": @"m", @"source": @"web", @"dayType": @"weekend" }; [PFAnalytics trackEvent:@"signup" dimensions:dimensions];

There is a default limit of 8 dimensions per event tracked.

Parameters

name	The name of the custom event to report to Parse as having happened.
dimensions	The `NSDictionary` of information by which to segment this event.
block	The block to execute on server response. It should have the following argument signature: `^(BOOL succeeded, NSError *error)`

The documentation for this class was generated from the following file:

Frameworks/Parse.framework/Headers/PFAnalytics.h

Class Methods

Detailed Description

Method Documentation