SLRequest

1.2.   SLRequest类参考

 

继承自	NSObject
符合	NSObject (NSObject)
框架	/System/Library/Frameworks/Social.framework
可用性	iOS6以及之后
声明在	Social/SLRequest.h

 

1.2.1.     概述

SLRequest对象封装了一个HTTP请求的属性，为你创建请求提供了一个方便的模板。你可以发送一个请求至社交网络服务中，来代表用户执行一些操作或者获取用户信息。

HTTP请求有一些通用的组件：一个HTTP请求的方法(GET，POST，DELETE)，一个URL来确定要执行的操作，一组查询参数，以及用一个可选的多字段POST body来包含附加信息。这些属性的值依赖于你所发送的请求和目标服务提供者。参考所支持的社交网络站点文档，以获知可能的值。在表2-1中是文档的链接。

使用requestForServiceType:requestMethod:URL:parameters:函数，根据具体的参数，初始化一个新的请求对象。使用addMultipartData:withName:type:方法有选择性的指定一个多字段POST body。当创建好请求之后，使用performRequestWithHandler:方法发送请求，并指定一个handler，当请求完成的时候该handler会被调用。如果你已经有了一个发送机制，可以使用preparedURLRequest方法来创建一个请求，这样就可以通过NSURLConnection对象来发送请求。如果请求需要用户授权，那么给account属性设置一个ACAccount对象。

 

表2-1 Social Services各自文档网站链接

Facebook	https://developers.facebook.com/docs/
Sina Weibo	http://open.weibo.com/wiki/
Twitter	https://dev.twitter.com/docs

 

1.2.2.     任务

初始化请求

+ requestForServiceType:requestMethod:URL:parameters:

根据具体的参数，初始化一个新的请求对象。

 

访问属性

account属性

      用于授权请求的账号信息。

 

requestMethod属性

      请求使用的方法。

 

URL属性

      请求的目的URL。

 

parameters属性

      请求使用到的参数。

 

发送请求

– performRequestWithHandler:

      执行一个异步请求，并且当请求结束的时候调用指定的handler。

 

– preparedURLRequest

      返回一个授权URL请求，可以使用NSURLConnection对象来发送该请求。

 

– addMultipartData:withName:type:

      为请求指定多字段POST body。

 

1.2.3.     属性

account

用于授权请求的账号信息

@property (nonatomic, retain) ACAccount *account

 

讨论

account用于登录一个OAuth1服务或者为OAuth2服务添加一个access token。与请求相关的account，token是自动添加进去的。account的默认值是nil。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

Parameters

请求的参数。(只读)

@property (nonatomic, readonly) NSDictionary *parameters

 

讨论

使用这个属性来查找HTTP请求的查询参数，这些参数是在requestForServiceType:requestMethod:URL:parameters:方法里设置的。可能出现的值依赖于目标服务，并且服务提供商会有相关文档。表2-1可以链接到所支持服务的相应的文档。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

 

requestMethod

请求使用的方法。(只读)

@property (nonatomic, readonly) SLRequestMethod requestMethod

 

讨论

使用这个属性来查找HTTP请求的方法，这个方法是在requestForServiceType:requestMethod:URL:parameters:方法里设置的。可能使用的值在“SLRequestMethod”里有描述。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

 

URL

请求的目的URL。（只读）

 

讨论

使用这个属性来查找HTTP请求的URL，这个属性是在requestForServiceType:requestMethod:URL:parameters:方法里设置的。可能使用的值在“SLRequestMethod”里有描述。可能出现的值依赖于目标服务，并且服务提供商会有相关文档。表2-1可以链接到所支持服务的相应的文档。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

1.2.4.     类方法

requestForServiceType:requestMethod:URL:parameters:

根据具体的参数，初始化一个新的请求对象

 

+ (SLRequest *)requestForServiceType:(NSString *)serviceType requestMethod:(SLRequestMethod)requestMethod URL:(NSURL *)url parameters:(NSDictionary*)parameters

 

参数

serviceType

      社交网络服务类型。“Service Type Constants”给出了可能的值。

 

requestMethod

      HTTP请求的方法。“SLRequestMethod” 给出了可能的值。

 

url

      HTTP请求的目的URL。URL的值和格式值依赖于目标服务，并且服务提供商会有相关文档。表2-1可以链接到所支持服务的相应的文档。

 

parameters

      HTTP请求的参数。参数的值和格式值依赖于目标服务，并且服务提供商会有相关文档。表2-1可以链接到所支持服务的相应的文档。

 

返回值

新初始化的请求对象。

 

讨论

使用这个方法来始初化SLRequest。每个参数的值和格式依赖于目标服务。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

1.2.5.     实例方法

addMultipartData:withName:type:

为请求指定多字段POST body。

 

- (void)addMultipartData:(NSData *)data withName:(NSString *)name type:(NSString*)type

 

参数

data

      多字段POST body的data，例如图片或者文字。

 

name

      多字段POST body的name，通常用来指定你post的data类型。

 

type

      多字段POST body的type，通常用来指定使用多字段数据的类型。

 

讨论

可能用到的参数值依赖于目标服务。这些信息以及使用多字段POST body的指导可以在服务提供商的文档中查看，表2-1可以链接到所支持服务的相应的文档。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

performRequestWithHandler:

执行一个异步请求，当请求结束时，调用指定的handler。

 

- (void)performRequestWithHandler:(SLRequestHandler)handler

 

参数

handler

      当请求结束时，handler会被调用。这个handler的参数在SLRequestHandler里有描述。这个参数不保证被任意的线程调用，并且不能为nil。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

 

preparedURLRequest

返回一个授权的URL请求，可以使用NSURLConnection对象进行发送。

 

- (NSURLRequest *)preparedURLRequest

 

返回值

一个OAuth-compatible NSURLRequest对象，允许应用程序代替用户来保存用户的密码。默认情况下，NSURLRequest使用OAuth1进行登录，或者使用OAuth2（在用户account中添加适当的token）。

 

讨论

在发送之前，使用这个方法来修改请求内容。如设置正确的account，这个方法会自动的添加需要用到的token。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h

 

 

1.2.6.     常量

Service Type Constants

serviceType参数可能的值

 

NSString *const SLServiceTypeFacebook;

NSString *const SLServiceTypeTwitter;

NSString *const SLServiceTypeSinaWeibo;

 

常量

SLServiceTypeFacebook

      字符串常量，用来标示Facebook社交网站

      可用于iOS6.0以及之后

      声明在SLRequest.h

 

SLServiceTypeTwitter

      字符串常量，用来标示Twitter社交网站

      可用于iOS6.0以及之后

      声明在SLRequest.h

 

SLServiceTypeSinaWeibo

      字符串常量，用来标示Weibo社交网站

      可用于iOS6.0以及之后

      声明在SLRequest.h

 

SLRequestMethod

标示请求中用到的请求方法。

 

typedef NS_ENUM(NSInteger,

SLRequestMethod) {

SLRequestMethodGET,

SLRequestMethodPOST,

SLRequestMethodDELETE

};

 

常量

SLRequestMethodGET

      从指定的资源请求信息。使用GET请求方法从指定的服务中获取信息，例如字符限制或用户时间表。

      可用于iOS6.0以及之后。

      声明在SLRequest.h。

 

SLRequestMethodPOST

      提交数据以进行处理。使用POST请求来提交信息至指定的服务中，例如状态的更新或者一张图片。

      可用于iOS6.0以及之后

      声明在SLRequest.h

 

SLRequestMethodDELETE

      删除指定的资源。

      可用于iOS6.0以及之后。

      声明在SLRequest.h。

 

讨论

使用这些常量来设置requestMethod属性。使用的请求方法依赖于目标服务。表2-1可以链接到所支持服务的相应的文档。

 

SLRequestHandler

请求的回调handler

 

typedef void(^SLRequestHandler)(NSData *responseData, NSHTTPURLResponse *urlResponse, NSError *error);

 

讨论

这个handler的参数如下：

 

responseData

      请求返回的数据。这个数据的格式取决于目标服务。

 

urlResponse

      请求返回的数据，包含了HTTP响应代码。

 

error

      错误标示

 

可能使用到的值依赖于目标服务，服务提供商会在相关文档中说明。表2-1可以链接到所支持服务的相应的文档。

 

可用性

可用于iOS6.0以及之后

 

声明在

SLRequest.h