-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPFTwitterUtils.h
More file actions
323 lines (248 loc) · 11.7 KB
/
PFTwitterUtils.h
File metadata and controls
323 lines (248 loc) · 11.7 KB
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
//
// PFTwitterUtils.h
//
// Copyright 2011-present Parse Inc. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <Parse/PFConstants.h>
#import <Parse/PFUser.h>
#import <Parse/PF_Twitter.h>
PF_ASSUME_NONNULL_BEGIN
@class BFTask;
/*!
The `PFTwitterUtils` class provides utility functions for working with Twitter in a Parse application.
This class is currently for iOS only.
*/
@interface PFTwitterUtils : NSObject
///--------------------------------------
/// @name Interacting With Twitter
///--------------------------------------
/*!
@abstract Gets the instance of the <PF_Twitter> object that Parse uses.
@returns An instance of <PF_Twitter> object.
*/
+ (PF_NULLABLE PF_Twitter *)twitter;
/*!
@abstract Initializes the Twitter singleton.
@warning You must invoke this in order to use the Twitter functionality in Parse.
@param consumerKey Your Twitter application's consumer key.
@param consumerSecret Your Twitter application's consumer secret.
*/
+ (void)initializeWithConsumerKey:(NSString *)consumerKey
consumerSecret:(NSString *)consumerSecret;
/*!
@abstract Whether the user has their account linked to Twitter.
@param user User to check for a Twitter link. The user must be logged in on this device.
@returns `YES` if the user has their account linked to Twitter, otherwise `NO`.
*/
+ (BOOL)isLinkedWithUser:(PF_NULLABLE PFUser *)user;
///--------------------------------------
/// @name Logging In & Creating Twitter-Linked Users
///--------------------------------------
/*!
@abstract *Asynchronously* logs in a user using Twitter.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically logs in (or creates, in the case where it is a new user) a <PFUser>.
@returns The task, that encapsulates the work being done.
*/
+ (BFTask *)logInInBackground;
/*!
@abstract *Asynchronously* logs in a user using Twitter.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically logs in (or creates, in the case where it is a new user) <PFUser>.
@param block The block to execute.
It should have the following argument signature: `^(PFUser *user, NSError *error)`.
*/
+ (void)logInWithBlock:(PF_NULLABLE PFUserResultBlock)block;
/*
@abstract *Asynchronously* Logs in a user using Twitter.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically logs in (or creates, in the case where it is a new user) a <PFUser>.
@param target Target object for the selector
@param selector The selector that will be called when the asynchrounous request is complete.
It should have the following signature: `(void)callbackWithUser:(PFUser *)user error:(NSError **)error`.
*/
+ (void)logInWithTarget:(PF_NULLABLE_S id)target selector:(PF_NULLABLE_S SEL)selector;
/*!
@abstract *Asynchronously* logs in a user using Twitter.
@discussion Allows you to handle user login to Twitter, then provide authentication
data to log in (or create, in the case where it is a new user) the <PFUser>.
@param twitterId The id of the Twitter user being linked.
@param screenName The screen name of the Twitter user being linked.
@param authToken The auth token for the user's session.
@param authTokenSecret The auth token secret for the user's session.
@returns The task, that encapsulates the work being done.
*/
+ (BFTask *)logInWithTwitterIdInBackground:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret;
/*!
@abstract Logs in a user using Twitter.
@discussion Allows you to handle user login to Twitter, then provide authentication data
to log in (or create, in the case where it is a new user) the <PFUser>.
@param twitterId The id of the Twitter user being linked
@param screenName The screen name of the Twitter user being linked
@param authToken The auth token for the user's session
@param authTokenSecret The auth token secret for the user's session
@param block The block to execute.
It should have the following argument signature: `^(PFUser *user, NSError *error)`.
*/
+ (void)logInWithTwitterId:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret
block:(PF_NULLABLE PFUserResultBlock)block;
/*
@abstract Logs in a user using Twitter.
@discussion Allows you to handle user login to Twitter, then provide authentication data
to log in (or create, in the case where it is a new user) the <PFUser>.
@param twitterId The id of the Twitter user being linked.
@param screenName The screen name of the Twitter user being linked.
@param authToken The auth token for the user's session.
@param authTokenSecret The auth token secret for the user's session.
@param target Target object for the selector.
@param selector The selector that will be called when the asynchronous request is complete.
It should have the following signature: `(void)callbackWithUser:(PFUser *)user error:(NSError *)error`.
*/
+ (void)logInWithTwitterId:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret
target:(PF_NULLABLE_S id)target
selector:(PF_NULLABLE_S SEL)selector;
///--------------------------------------
/// @name Linking Users with Twitter
///--------------------------------------
/*!
@abstract *Asynchronously* links Twitter to an existing PFUser.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically links the account to the <PFUser>.
@param user User to link to Twitter.
@deprecated Please use `[PFTwitterUtils linkUserInBackground:]` instead.
*/
+ (void)linkUser:(PFUser *)user PARSE_DEPRECATED("Please use +linkUserInBackground: instead.");
/*!
@abstract *Asynchronously* links Twitter to an existing <PFUser>.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically links the account to the <PFUser>.
@param user User to link to Twitter.
@returns The task, that encapsulates the work being done.
*/
+ (BFTask *)linkUserInBackground:(PFUser *)user;
/*!
@abstract *Asynchronously* links Twitter to an existing <PFUser>.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically links the account to the <PFUser>.
@param user User to link to Twitter.
@param block The block to execute.
It should have the following argument signature: `^(BOOL success, NSError *error)`.
*/
+ (void)linkUser:(PFUser *)user block:(PF_NULLABLE PFBooleanResultBlock)block;
/*
@abstract *Asynchronously* links Twitter to an existing <PFUser>.
@discussion This method delegates to Twitter to authenticate the user,
and then automatically links the account to the <PFUser>.
@param user User to link to Twitter.
@param target Target object for the selector
@param selector The selector that will be called when the asynchrounous request is complete.
It should have the following signature: `(void)callbackWithResult:(NSNumber *)result error:(NSError *)error`.
*/
+ (void)linkUser:(PFUser *)user
target:(PF_NULLABLE_S id)target
selector:(PF_NULLABLE_S SEL)selector;
/*!
@abstract *Asynchronously* links Twitter to an existing PFUser asynchronously.
@discussion Allows you to handle user login to Twitter,
then provide authentication data to link the account to the <PFUser>.
@param user User to link to Twitter.
@param twitterId The id of the Twitter user being linked.
@param screenName The screen name of the Twitter user being linked.
@param authToken The auth token for the user's session.
@param authTokenSecret The auth token secret for the user's session.
@returns The task, that encapsulates the work being done.
*/
+ (BFTask *)linkUserInBackground:(PFUser *)user
twitterId:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret;
/*!
@abstract *Asynchronously* links Twitter to an existing <PFUser>.
@discussionAllows you to handle user login to Twitter,
then provide authentication data to link the account to the <PFUser>.
@param user User to link to Twitter.
@param twitterId The id of the Twitter user being linked.
@param screenName The screen name of the Twitter user being linked.
@param authToken The auth token for the user's session.
@param authTokenSecret The auth token secret for the user's session.
@param block The block to execute.
It should have the following argument signature: `^(BOOL success, NSError *error)`.
*/
+ (void)linkUser:(PFUser *)user
twitterId:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret
block:(PF_NULLABLE PFBooleanResultBlock)block;
/*
@abstract Links Twitter to an existing <PFUser>.
@discussion This method allows you to handle user login to Twitter,
then provide authentication data to link the account to the <PFUser>.
@param user User to link to Twitter.
@param twitterId The id of the Twitter user being linked.
@param screenName The screen name of the Twitter user being linked.
@param authToken The auth token for the user's session.
@param authTokenSecret The auth token secret for the user's session.
@param target Target object for the selector.
@param selector The selector that will be called when the asynchronous request is complete.
It should have the following signature: `(void)callbackWithResult:(NSNumber *)result error:(NSError *)error`.
*/
+ (void)linkUser:(PFUser *)user
twitterId:(NSString *)twitterId
screenName:(NSString *)screenName
authToken:(NSString *)authToken
authTokenSecret:(NSString *)authTokenSecret
target:(PF_NULLABLE_S id)target
selector:(PF_NULLABLE_S SEL)selector;
///--------------------------------------
/// @name Unlinking Users from Twitter
///--------------------------------------
/*!
@abstract *Synchronously* unlinks the <PFUser> from a Twitter account.
@param user User to unlink from Twitter.
@returns Returns true if the unlink was successful.
*/
+ (BOOL)unlinkUser:(PFUser *)user;
/*!
@abstract *Synchronously* unlinks the PFUser from a Twitter account.
@param user User to unlink from Twitter.
@param error Error object to set on error.
@returns Returns `YES` if the unlink was successful, otherwise `NO`.
*/
+ (BOOL)unlinkUser:(PFUser *)user error:(NSError **)error;
/*!
@abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
@param user User to unlink from Twitter.
@returns The task, that encapsulates the work being done.
*/
+ (BFTask *)unlinkUserInBackground:(PFUser *)user;
/*!
@abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
@param user User to unlink from Twitter.
@param block The block to execute.
It should have the following argument signature: `^(BOOL succeeded, NSError *error)`.
*/
+ (void)unlinkUserInBackground:(PFUser *)user
block:(PF_NULLABLE PFBooleanResultBlock)block;
/*
@abstract Makes an *asynchronous* request to unlink a user from a Twitter account.
@param user User to unlink from Twitter
@param target Target object for the selector
@param selector The selector that will be called when the asynchrounous request is complete.
*/
+ (void)unlinkUserInBackground:(PFUser *)user
target:(PF_NULLABLE_S id)target
selector:(PF_NULLABLE_S SEL)selector;
@end
PF_ASSUME_NONNULL_END