forked from orta/ARAnalytics
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ARAnalyticalProvider.h
47 lines (32 loc) · 1.81 KB
/
ARAnalyticalProvider.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@class UINavigationController, UIViewController;
extern NSString *const ARAnalyticalProviderNewPageViewEventName;
extern NSString *const ARAnalyticalProviderNewPageViewEventScreenPropertyKey;
@interface ARAnalyticalProvider : NSObject
/// Init
- (id)initWithIdentifier:(NSString *)identifier;
/// Set a per user property
- (void)identifyUserWithID:(NSString *)userID andEmailAddress:(NSString *)email;
- (void)setUserProperty:(NSString *)property toValue:(NSString *)value;
/// Submit user events
- (void)event:(NSString *)event withProperties:(NSDictionary *)properties;
- (void)incrementUserProperty:(NSString *)counterName byInt:(NSNumber *)amount;
/// Submit errors
- (void)error:(NSError *)error withMessage:(NSString *)message;
/// Monitor Navigation changes as page view
- (void)monitorNavigationViewController:(UINavigationController *)controller;
/// Submit an event with a time interval
- (void)logTimingEvent:(NSString *)event withInterval:(NSNumber *)interval;
/// Submit an event with a time interval and extra properties
/// @warning the properites must not contain the key string `length`.
- (void)logTimingEvent:(NSString *)event withInterval:(NSNumber *)interval properties:(NSDictionary *)properties;
/// Pass a specific event for showing a page
- (void)didShowNewPageView:(NSString *)pageTitle;
/// Pass a specific event for showing a page with additional properties
- (void)didShowNewPageView:(NSString *)pageTitle withProperties:(NSDictionary *)properties;
/// Submit a string to the provider's logging system
- (void)remoteLog:(NSString *)parsedString;
/// Submit a string to the local persisted logging system
- (void)localLog:(NSString *)message;
/// Retrieve messages provided to the local persisted logging system originating from a specified process.
- (NSArray *)messagesForProcessID:(NSUInteger)processID;
@end