| commit | author | age | ||
| 655e66 | 1 | /* |
| H | 2 | * Copyright (C) 2017 Twitter, Inc. |
| 3 | * | |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
| 5 | * you may not use this file except in compliance with the License. | |
| 6 | * You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, software | |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 13 | * See the License for the specific language governing permissions and | |
| 14 | * limitations under the License. | |
| 15 | * | |
| 16 | */ | |
| 17 | ||
| a0a843 | 18 | #import <Foundation/Foundation.h> |
| H | 19 | #import "TWTRScribeSerializable.h" |
| 20 | ||
| 7be7ad | 21 | FOUNDATION_EXPORT NSString *const TWTRScribeClientEventNamespaceEmptyValue; |
| a0a843 | 22 | |
| H | 23 | /** |
| 24 | * Model object for describing any client events at Twitter. | |
| 25 | * @see https://confluence.twitter.biz/display/ANALYTICS/client_event+Namespacing | |
| 26 | */ | |
| 27 | @interface TWTRScribeClientEventNamespace : NSObject <TWTRScribeSerializable> | |
| 28 | ||
| 29 | /** | |
| 30 | * The client application logging the event. | |
| 31 | */ | |
| 32 | @property (nonatomic, copy, readonly) NSString *client; | |
| 33 | ||
| 34 | /** | |
| 35 | * The page or functional grouping where the event occurred | |
| 36 | */ | |
| 37 | @property (nonatomic, copy, readonly) NSString *page; | |
| 38 | ||
| 39 | /** | |
| 40 | * A stream or tab on a page. | |
| 41 | */ | |
| 42 | @property (nonatomic, copy, readonly) NSString *section; | |
| 43 | ||
| 44 | /** | |
| 45 | * The actual page component, object, or objects where the event occurred. | |
| 46 | */ | |
| 47 | @property (nonatomic, copy, readonly) NSString *component; | |
| 48 | ||
| 49 | /** | |
| 50 | * A UI element within the component that can be interacted with. | |
| 51 | */ | |
| 52 | @property (nonatomic, copy, readonly) NSString *element; | |
| 53 | ||
| 54 | /** | |
| 55 | * The action the user or application took. | |
| 56 | */ | |
| 57 | @property (nonatomic, copy, readonly) NSString *action; | |
| 58 | ||
| 7be7ad | 59 | - (instancetype)init __unavailable; |
| a0a843 | 60 | - (instancetype)initWithClient:(NSString *)client page:(NSString *)page section:(NSString *)section component:(NSString *)component element:(NSString *)element action:(NSString *)action __attribute__((nonnull)); |
| H | 61 | |
| 62 | #pragma mark - Errors | |
| 63 | ||
| 64 | /** | |
| 65 | * Describes generic errors encounted inside Twitter Kits. | |
| 66 | */ | |
| 67 | + (instancetype)errorNamespace; | |
| 68 | ||
| 69 | @end | |
