| commit | author | age | ||
| a0a843 | 1 | // |
| H | 2 | // TWTRScribeClientEventNamespace.h |
| 3 | // TwitterKit | |
| 4 | // | |
| 5 | // Created by Kang Chen on 11/14/14. | |
| 6 | // Copyright (c) 2014 Twitter. All rights reserved. | |
| 7 | // | |
| 8 | ||
| 9 | #import <Foundation/Foundation.h> | |
| 10 | #import "TWTRScribeSerializable.h" | |
| 11 | ||
| 12 | FOUNDATION_EXPORT NSString *const TWTRScribeClientEventNamespaceEmptyValue; | |
| 13 | ||
| 14 | /** | |
| 15 | * Model object for describing any client events at Twitter. | |
| 16 | * @see https://confluence.twitter.biz/display/ANALYTICS/client_event+Namespacing | |
| 17 | */ | |
| 18 | @interface TWTRScribeClientEventNamespace : NSObject <TWTRScribeSerializable> | |
| 19 | ||
| 20 | /** | |
| 21 | * The client application logging the event. | |
| 22 | */ | |
| 23 | @property (nonatomic, copy, readonly) NSString *client; | |
| 24 | ||
| 25 | /** | |
| 26 | * The page or functional grouping where the event occurred | |
| 27 | */ | |
| 28 | @property (nonatomic, copy, readonly) NSString *page; | |
| 29 | ||
| 30 | /** | |
| 31 | * A stream or tab on a page. | |
| 32 | */ | |
| 33 | @property (nonatomic, copy, readonly) NSString *section; | |
| 34 | ||
| 35 | /** | |
| 36 | * The actual page component, object, or objects where the event occurred. | |
| 37 | */ | |
| 38 | @property (nonatomic, copy, readonly) NSString *component; | |
| 39 | ||
| 40 | /** | |
| 41 | * A UI element within the component that can be interacted with. | |
| 42 | */ | |
| 43 | @property (nonatomic, copy, readonly) NSString *element; | |
| 44 | ||
| 45 | /** | |
| 46 | * The action the user or application took. | |
| 47 | */ | |
| 48 | @property (nonatomic, copy, readonly) NSString *action; | |
| 49 | ||
| 50 | - (instancetype)init __unavailable; | |
| 51 | - (instancetype)initWithClient:(NSString *)client page:(NSString *)page section:(NSString *)section component:(NSString *)component element:(NSString *)element action:(NSString *)action __attribute__((nonnull)); | |
| 52 | ||
| 53 | #pragma mark - Errors | |
| 54 | ||
| 55 | /** | |
| 56 | * Describes generic errors encounted inside Twitter Kits. | |
| 57 | */ | |
| 58 | + (instancetype)errorNamespace; | |
| 59 | ||
| 60 | @end | |
