IMSIoTRequestBuilder Class Reference

Inherits from NSObject
Declared in IMSIoTRequestBuilder.h

Overview

用于构建 API 通道请求对象

– initWithPath:apiVersion:params:

初始化接口

- (instancetype)initWithPath:(NSString *)path apiVersion:(NSString *)apiVersion params:(NSDictionary *)params

Parameters

path

API 请求的 path 部分
apiVersion

API 版本
params

API 参数

Discussion

初始化接口

对于一个 URL https://www.example.com/index.html，scheme 为 https，host 为 www.example.com，path 为 /index.html

Declared In

IMSIoTRequestBuilder.h

– initWithRequest:

根据一个已有的 request 构造一个 builder

- (instancetype _Nullable)initWithRequest:(IMSRequest *)request

Parameters

request

一个已有的 IMSRequest 实例

Discussion

根据一个已有的 request 构造一个 builder

Declared In

IMSIoTRequestBuilder.h

– setHost:

设置当前 API 请求的域名，不设置时从 IMSConfiguration 的 host 字段读取

- (IMSIoTRequestBuilder *)setHost:(NSString *)host

Parameters

host

API 通道请求的 host 部分

Return Value

返回当前实例

Discussion

设置当前 API 请求的域名，不设置时从 IMSConfiguration 的 host 字段读取

Declared In

IMSIoTRequestBuilder.h

– addParameter:forKey:

添加业务参数，是一个键值对（key:value）

- (IMSIoTRequestBuilder *)addParameter:(id)value forKey:(NSString *)key

Parameters

value

参数的value部分
key

参数的key部分

Return Value

返回当前实例

Discussion

添加业务参数，是一个键值对（key:value）

Declared In

IMSIoTRequestBuilder.h

– removeParameterForKey:

移除业务参数，是一个键值对（key:value）

- (IMSIoTRequestBuilder *)removeParameterForKey:(NSString *)key

Parameters

key

待移除参数的key部分

Return Value

返回当前实例

Discussion

移除业务参数，是一个键值对（key:value）

Declared In

IMSIoTRequestBuilder.h

– setScheme:

默认 scheme 为 https

- (IMSIoTRequestBuilder *)setScheme:(NSString *)scheme

Parameters

scheme

设置当前 API 请求的 scheme，为 https 或 http

Return Value

返回当前实例

Discussion

默认 scheme 为 https

Declared In

IMSIoTRequestBuilder.h

– addRequestItem:forKey:

往 IoT 协议 Request 字段添加一个键值对（key:value）

- (IMSIoTRequestBuilder *)addRequestItem:(id)value forKey:(NSString *)key

Parameters

value

参数的value部分
key

参数的key部分

Return Value

返回当前实例

Discussion

往 IoT 协议 Request 字段添加一个键值对（key:value）

Declared In

IMSIoTRequestBuilder.h

– removeRequestItem:forKey:

从 IoT 协议 Request 字段移除一个键值对（key:value）

- (IMSIoTRequestBuilder *)removeRequestItem:(id)value forKey:(NSString *)key

Parameters

value

参数的value部分
key

参数的key部分

Return Value

返回当前实例

Discussion

从 IoT 协议 Request 字段移除一个键值对（key:value）

Declared In

IMSIoTRequestBuilder.h

– setAuthenticationType:

设置 API 请求认证类型，相应的类型和实现必须先在 IMSRequestClient 类中注册才可使用

- (IMSIoTRequestBuilder *)setAuthenticationType:(NSString *)authType

Parameters

authType

指定认证类型

Return Value

返回当前实例

Discussion

设置 API 请求认证类型，相应的类型和实现必须先在 IMSRequestClient 类中注册才可使用

Declared In

IMSIoTRequestBuilder.h

– removeAuthenticationType

移除 API 请求认证类型

- (IMSIoTRequestBuilder *)removeAuthenticationType

Return Value

返回当前实例

Discussion

移除 API 请求认证类型

Declared In

IMSIoTRequestBuilder.h

– setRequestTimeoutInterval:

设置 API 请求超时时间

- (IMSIoTRequestBuilder *)setRequestTimeoutInterval:(NSUInteger)timeoutInterval

Parameters

timeoutInterval

请求超时时间 单位为秒

Return Value

返回当前实例

Discussion

设置 API 请求超时时间

Declared In

IMSIoTRequestBuilder.h

– build

构建 API 通道请求对象

- (IMSRequest *)build

Return Value

返回 API 通道请求对象

Discussion

构建 API 通道请求对象

Declared In

IMSIoTRequestBuilder.h