• jz's avatar
    add files · a955fb1d
    jz authored
    a955fb1d
WBHttpRequest+WeiboUser.h 19.8 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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
//
//  WBHttpRequest+WeiboUser.h
//  WeiboSDK
//
//  Created by DannionQiu on 14-9-23.
//  Copyright (c) 2014年 SINA iOS Team. All rights reserved.
//

#import "WBHttpRequest.h"

@interface WBHttpRequest (WeiboUser)

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/friends".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the user's friends.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the
 user's friends.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/friends/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFriendsListOfUser:(NSString*)currentUserID
                               withAccessToken:(NSString*)accessToken
                            andOtherProperties:(NSDictionary*)otherProperties
                                         queue:(NSOperationQueue*)queue
                         withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/friends/ids".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the user's friends' UserID.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of NSString representing the
 user's friends' UserID.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/friends/ids/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFriendsUserIDListOfUser:(NSString*)currentUserID
                                     withAccessToken:(NSString*)accessToken
                                  andOtherProperties:(NSDictionary*)otherProperties
                                               queue:(NSOperationQueue*)queue
                               withCompletionHandler:(WBRequestHandler)handler;


/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/friends/in_common".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the common friends list between two users..
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the
 user's friends.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/friends/in_common/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForCommonFriendsListBetweenUser:(NSString*)currentUserID
                                                  andUser:(NSString*)anotherUserID
                                          withAccessToken:(NSString*)accessToken
                                       andOtherProperties:(NSDictionary*)otherProperties
                                                    queue:(NSOperationQueue*)queue
                                    withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/friends/bilateral".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the list of the users that are following the specified user and are being followed by the specified user.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the
 users that are following the specified user and are being followed by the specified user.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/friends/bilateral/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForBilateralFriendsListOfUser:(NSString*)currentUserID
                                        withAccessToken:(NSString*)accessToken
                                     andOtherProperties:(NSDictionary*)otherProperties
                                                  queue:(NSOperationQueue*)queue
                                  withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/followers".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the user's followers.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the
 user's followers.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/followers/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFollowersListOfUser:(NSString*)currentUserID
                                 withAccessToken:(NSString*)accessToken
                              andOtherProperties:(NSDictionary*)otherProperties
                                           queue:(NSOperationQueue*)queue
                           withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/followers/ids".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the user's followers' UserID.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of NSString representing the
 user's followers' UserID.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/followers/ids/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFollowersUserIDListOfUser:(NSString*)currentUserID
                                     withAccessToken:(NSString*)accessToken
                                  andOtherProperties:(NSDictionary*)otherProperties
                                               queue:(NSOperationQueue*)queue
                               withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/followers/active".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the active(high quality) followers list of a user.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the active(high quality) followers list of a user.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/followers/active/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForActiveFollowersListOfUser:(NSString*)currentUserID
                                       withAccessToken:(NSString*)accessToken
                                    andOtherProperties:(NSDictionary*)otherProperties
                                                 queue:(NSOperationQueue*)queue
                                 withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/friends_chain/followers".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the users that are being followed by the authenticating user and are following the specified user.
 
 A successful Open API call will return an NSDictionary of objects which contanis an array of <WeiboUser> objects representing the users that are being followed by the authenticating user and are following the specified user.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/friends_chain/followers/en
 
 @param currentUserID       should be the current User's UserID which has been authorized.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForBilateralFollowersListOfUser:(NSString*)currentUserID
                                          withAccessToken:(NSString*)accessToken
                                       andOtherProperties:(NSDictionary*)otherProperties
                                                    queue:(NSOperationQueue*)queue
                                    withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/show".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve the relationship of two users.
 
 A successful Open API call will return an NSDictionary of objects which contanis the relationship of two users.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/show
 
 @param targetUserID        a User ID
 
 @param sourceUserID        a User ID
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFriendshipDetailBetweenTargetUser:(NSString*)targetUserID
                                                 andSourceUser:(NSString*)sourceUserID
                                               withAccessToken:(NSString*)accessToken
                                            andOtherProperties:(NSDictionary*)otherProperties
                                                         queue:(NSOperationQueue*)queue
                                         withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/create".
 
 @discussion
 Simplifies preparing a request and sending request to Follow a user.
 
 A successful Open API call will return an <WeiboUser> object representing the user to be followed.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/create/en
 
 @param theUserToBeFollowed the userID of the user which you want to follow.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForFollowAUser:(NSString*)theUserToBeFollowed
                         withAccessToken:(NSString*)accessToken
                      andOtherProperties:(NSDictionary*)otherProperties
                                   queue:(NSOperationQueue*)queue
                   withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/destroy".
 
 @discussion
 Simplifies preparing a request and sending request to cancel following a user.
 
 A successful Open API call will return an <WeiboUser> object representing the user to be followed.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/destroy/en
 
 @param theUserThatYouDontLike the userID of the user which you want to cancel following.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForCancelFollowAUser:(NSString*)theUserThatYouDontLike
                               withAccessToken:(NSString*)accessToken
                            andOtherProperties:(NSDictionary*)otherProperties
                                         queue:(NSOperationQueue*)queue
                         withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "friendships/followers/destroy".
 
 @discussion
 Simplifies preparing a request and sending request to remove a follower of the authenticating user.
 
 A successful Open API call will return an <WeiboUser> object representing the user to be followed.
 
 this API requires advanced level authorization. You can see more details about advanced level authorization in http://open.weibo.com/wiki/%E6%8E%88%E6%9D%83%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E#scope
 
 You can see more details about this API in http://open.weibo.com/wiki/2/friendships/followers/destroy/en
 
 @param theUserThatYouDontLike the userID of the follower which you want to remove.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForRemoveFollowerUser:(NSString*)theUserThatYouDontLike
                                 withAccessToken:(NSString*)accessToken
                              andOtherProperties:(NSDictionary*)otherProperties
                                           queue:(NSOperationQueue*)queue
                           withCompletionHandler:(WBRequestHandler)handler;

/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "messages/invite".
 
 @discussion
 Simplifies preparing a request and sending request to send invitation to a bilateral friend of the authenticating user.
 
 A successful Open API call will return  an NSDictionary of objects which contanis <WeiboUser> objects representing sender and receiver and other invitation details.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/messages/invite
 
 @param theUserThatShouldBeYourBilateralFriend    the userID of the follower which you want to remove.
 
 @param accessToken         The token string.
 
 @param text                The text content in your invitation message. should not be nil.
 
 @param url                 The url in your invitation message. can be nil.

 @param logoUrl             The logoUrl in your invitation message. can be nil.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForInviteBilateralFriend:(NSString*)theUserThatShouldBeYourBilateralFriend
                                   withAccessToken:(NSString*)accessToken
                                        inviteText:(NSString*)text
                                         inviteUrl:(NSString*)url
                                     inviteLogoUrl:(NSString*)logoUrl
                                             queue:(NSOperationQueue*)queue
                             withCompletionHandler:(WBRequestHandler)handler;


/*!
 @method
 
 @abstract
 Creates a request representing a Open API call to the "users/show".
 
 @discussion
 Simplifies preparing a request and sending request to retrieve user profile by user ID..
 
 A successful Open API call will return a <WeiboUser> object representing the user profile by user ID.
 
 You can see more details about this API in http://open.weibo.com/wiki/2/users/show/en
 
 @param aUserID             a User ID.
 
 @param accessToken         The token string.
 
 @param otherProperties     Any additional properties for the Open API Request.
 
 @param queue               specify the queue that you want to send request on, if this param is nil, the request will be start on MainQueue( [NSOperationQueue mainQueue] ).
 
 @param handler             the comletion block which will be executed after received response from Open API server.
 */
+ (WBHttpRequest *)requestForUserProfile:(NSString*)aUserID
                         withAccessToken:(NSString*)accessToken
                      andOtherProperties:(NSDictionary*)otherProperties
                                   queue:(NSOperationQueue*)queue
                   withCompletionHandler:(WBRequestHandler)handler;

@end