添加V3.6.7

hank

2018-04-18 655e6650051a9c08675d15e05ac3b7d9be98e714

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
 * Copyright (C) 2017 Twitter, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
/**
 This header is private to the Twitter Core SDK and not exposed for public SDK consumption
 */
 
#import <Foundation/Foundation.h>
#import "TFSScribe.h"
#import "TWTRScribeClientEventNamespace.h"
#import "TWTRScribeItem.h"
 
NS_ASSUME_NONNULL_BEGIN
 
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionClient;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionPage;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionSectionTweet;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionSectionQuoteTweet;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionSectionVideo;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionSectionGallery;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionSectionAuth;
 
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionComponent;
FOUNDATION_EXTERN NSString *const TWTRScribeEmptyKey;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionTypeLoad;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionTypeImpression;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionTypeShare;
FOUNDATION_EXTERN NSString *const TWTRScribeEventImpressionAction;
FOUNDATION_EXTERN NSString *const TWTRScribeEventActionClick;
FOUNDATION_EXTERN NSString *const TWTRScribeEventActionFilter;
 
FOUNDATION_EXTERN NSString *const TWTRScribeEventUniquesClient;
FOUNDATION_EXTERN NSString *const TWTRScribeEventUniquesPageTweetViews;
FOUNDATION_EXTERN NSString *const TWTRScribeEventUniquesPageLogin;
FOUNDATION_EXTERN NSString *const TWTRScribeEventUniquesAction;
 
FOUNDATION_EXTERN NSString *const TWTRScribeActionLike;
FOUNDATION_EXTERN NSString *const TWTRScribeActionUnlike;
FOUNDATION_EXTERN NSString *const TWTRScribeActionStart;
FOUNDATION_EXTERN NSString *const TWTRScribeActionSuccess;
FOUNDATION_EXTERN NSString *const TWTRScribeActionCancelled;
FOUNDATION_EXTERN NSString *const TWTRScribeActionFailure;
 
/**
 *  Possible values for which category to scribe events to.
 */
typedef NS_ENUM(NSUInteger, TWTRScribeEventCategory) {
    /**
     *  Used for logging impressions and feature usage for Tweet views.
     */
    TWTRScribeEventCategoryImpressions = 1,
    /**
     *  Used only for logging number of uniques using the Kit. There are no browsing history logged,
     *  so we can keep the events longer to calculate monthly actives.
     */
    TWTRScribeEventCategoryUniques
};
 
@interface TWTRScribeEvent : NSObject <TFSScribeEventParameters>
 
@property (nonatomic, copy, readonly, nullable) NSString *userID;
@property (nonatomic, copy, readonly, nullable) NSString *tweetID;
@property (nonatomic, copy, readonly) NSString *eventInfo;
@property (nonatomic, assign, readonly) TWTRScribeEventCategory category;
@property (nonatomic, copy, readonly) TWTRScribeClientEventNamespace *eventNamespace;
@property (nonatomic, copy, readonly) NSArray<TWTRScribeItem *> *items;
 
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithUserID:(nullable NSString *)userID tweetID:(nullable NSString *)tweetID category:(TWTRScribeEventCategory)category eventNamespace:(TWTRScribeClientEventNamespace *)eventNamespace items:(nullable NSArray<TWTRScribeItem *> *)items;
 
- (instancetype)initWithUserID:(nullable NSString *)userID eventInfo:(nullable NSString *)eventInfo category:(TWTRScribeEventCategory)category eventNamespace:(TWTRScribeClientEventNamespace *)eventNamespace items:(nullable NSArray<TWTRScribeItem *> *)items;
 
#pragma mark - TFSScribeEventParameters
 
- (NSDictionary *)dictionaryRepresentation;
- (NSString *)userID;
- (NSData *)data;
 
@end
 
/**
 *  A Scribe event for logging errors to the Twitter backend
 */
@interface TWTRErrorScribeEvent : TWTRScribeEvent
 
@property (nonatomic, readonly) NSError *error;
@property (nonatomic, copy, readonly) NSString *errorMessage;
 
/**
 *  Initializer
 *
 *  @param error        (optional) An NSError object representing this error case.
 *  @param errorMessage (required) An error message describing the error situation.
 *
 *  @return A fully initialized scribe object ready to enqueue or nil if any of
 *          the required parameters are missing.
 */
- (instancetype)initWithError:(nullable NSError *)error message:(NSString *)errorMessage;
 
@end
 
NS_ASSUME_NONNULL_END