分享到 :

iOS_SDK_API_使用说明

1. SSO安全登录QQ帐号

iOS SDK支持应用跳转到手机QQ进行登录,给用户提供更加安全、快捷的体验 。如果用户没有安装手机QQ,将打开登录页面。

2. 分享到QQ和QQ空间

2.1 分享到QQ好友

分享到QQ好友支持发送:

  • - 纯文本消息(QQApiTextObject)
  • - 纯图片消息(QQApiImageObject)
  • - 新闻类消息(QQApiNewsObject)
  • - 音频类消息(QQApiImageObject)
  • - 视频类消息(QQApiVideoObject)

在用户安装了手机QQ时通过手机QQ进行分享,否则调用浏览器页面进行分享。
其中文本消息,图文消息和音频消息的title是必须的,summary可以不填,具体调用请参考2.3 分享示例代码
使用分享到QQ好友功能需要设置QQ业务回调,请参考6. 处理QQ业务的回调

2.2 分享到QQ空间

分享到QQ空间的接口用于取代老的分享接口addShareWithParams(该接口已经废弃)。
分享到QQ空间支持发送:
- 带有URL的消息
- 新闻类消息(QQApiNewsObject)
- 音频类消息(QQApiImageObject)
- 视频类消息(QQApiVideoObject)
分享时调用浏览器页面进行分享。其中title是必须的,summary可以不填,具体调用请参考2.3 分享示例代码
使用分享到QQ空间功能需要设置QQ业务回调,请参考6. 处理QQ业务的回调

 

2.3 分享示例代码

下面是各种分享消息的实例代码,作为开发者调用QQ好友分享和QQ空间分享的参考:
纯文本分享:

 

纯图片分享:

 

新闻分享:

 

 

音乐分享:

视频分享:

注意:
分享到QQ空间接口暂时不支持发送多张图片的能力,若开发者传入多张图片,则会自动选入第一张图片作为预览图。多图的能力将在以后支持。

 

3. 调用OpenAPI

SDK中具体支持的API种类和每条API的参数说明,请参照API列表。这里用设置用户头像举例说明。

3.1 OpenAPI参数字典封装

在封装各接口的参数字典时,推荐使用为每个接口新增的参数封装辅助类,如:
接口(BOOL)addShareWithParams:(NSMutableDictionary *)params
对应辅助类TCAddShareDic

 

TCAddShareDic辅助类中属性:
@property (nonatomic, retain) TCRequiredStr paramTitle;
对应于CGI请求中参数"title"

 

TCRequiredStr 表示这是一个必填参数,类型是字符串
TCOptionalStr 表示这是一个可选参数,类型是字符串

 

3.2 设置用户头像调用示例

设置QQ头像时,调用TencetnOAuth对象的setUserHeadpic方法:

 

设置头像完成后,会调用TencentSessionDelegate中的tencentOAuth:doCloseViewController通知应用界面需要关闭:

 

设置头像完成后,会调用TencentSessionDelegate中的setUserHeadpicResponse返回调用结果:

 

3.3 使用增量授权

当第三方应用调用某个API接口时,如果服务器返回操作未被授权,则会触发增量授权逻辑。第三方应用需自行实现tencentNeedPerformIncrAuth:withPermissions:协议接口才能够进入增量授权逻辑,否则默认第三方应用放弃增量授权。示例如下:

 

注意:在用户通过增量授权页重新授权登录后,第三方应用需更新自己维护的token及有效期限等信息。
**用户在增量授权时是可以更换帐号进行登录的,强烈要求第三方应用核对增量授权后的用户openid是否一致,以添加必要的处理逻辑(用户帐号变更需重新拉取用户的资料等信息)**
增量授权成功时,会通过tencentDidUpdate:协议接口通知第三方应用:

 

增量授权失败时,会通过tencentFailedUpdate:协议接口通知第三方应用:

 

3.4 返回数据说明

APIResponse属性:
retCode - 网络请求返回码,主要表示服务器是否成功返回数据
seq - 请求的序列号,依次递增,方便内部管理
errorMsg - 错误消息
jsonResponse - 由服务器返回的json格式字符串转换而来的json字典数据(具体参数字段请参见对应API说明文档)
message - 服务器返回的原始字符串数据
detailRetCode - 新增的详细错误码,以区分不同的错误原因(v1.2以及之前的SDK接口无此参数)

 

3.5 返回码说明

retCode网络请求返回码说明:
0 表示成功,请求成功发送到服务器,并且服务器返回的数据格式正确
1 表示失败,可能原因有网络异常,或服务器返回的数据格式错误,无法解析

detailRetCode详细错误码说明:
kOpenSDKInvalid -无效的错误码

[公共错误码]
kOpenSDKErrorSuccess - 成功
kOpenSDKErrorUnknown - 未知错误
kOpenSDKErrorUserCancel - 用户取消
kOpenSDKErrorReLogin - token无效或用户未授权相应权限需要重新登录
kOpenSDKErrorOperationDeny - 第三方应用没有该api操作的权限

[网络相关错误码]
kOpenSDKErrorNetwork - 网络错误,网络不通或连接不到服务器
kOpenSDKErrorURL - URL格式或协议错误
kOpenSDKErrorDataParse - 数据解析错误,服务器返回的数据解析出错
kOpenSDKErrorParam - 传入参数错误
kOpenSDKErrorConnTimeout - http连接超时
kOpenSDKErrorSecurity - 安全问题
kOpenSDKErrorIO - 下载和文件IO错误
kOpenSDKErrorServer - 服务器端错误

[webview中特有错误]
kOpenSDKErrorWebPage - 页面错误

[设置头像 自定义错误码段]
kOpenSDKErrorUserHeadPicLarge - 图片过大 设置头像自定义错误码

 

4. 调用微云接口

iOS SDK支持调用腾讯微云的接口,支持对照片,音频,视频,结构化数据的上传,下载,删除等能力。下面以微云照片上传为例,向开发者介绍如何向腾讯微云上传照片。

4.1创建微云request对象,调用TencentOAuth实例的统一发送接口

 

4.2 实现TCAPIRequestDelegate协议,响应结果

-(void)cgiRquest:didResponse用来响应统一api的调用结果,request是请求的消息,response是响应的结果。

 

注意:
上传图片是两步的过程。需要先获得上传参数,再根据上传参数拼装HTTP协议上传到微云的服务器。两步是分开进行的,所以需要注意两个问题。
1.第三方需要将上传对象进行保存,否则将无法进行默认的大数据上传。
2.iOS SDK 1.8实现了拉取上传参数和数据的上传。但是上传没有实现断点续传,所以对大数据的上传支持有限,可以通过实现 TCAPIRequestUploadDelegate 和 TCAPIRequestDownloadDelegate 来取消内部的自动上传和下载的逻辑,获得上传下载参数后自己拼装请求参数。
TCAPIRequestUploadDelegate 协议:

 

TCAPIRequestDownloadDelegate 协议:

如果不实现上传、下载协议,则按默认方式进行数据的上传下载。第三方实现协议若返回YES,则默认进行数据的上传下载。返回NO则停止上传下载。由第三方获取当前数据后自己上传下载数据。

其他API统一接口的调用参照上传照片的调用方式。目前统一接口主要支持微云所有API接口的调用和微博上传带有图片微博的调用,具体可以参考WeiyunAPI.h和WeiboAPI.h中有关微云和微博TCAPIRequest对象的定义。

 

5. WPA临时会话

iOS SDK支持发起QQ临时会话,获取指定QQ帐号在线状态。使用WPA功能需要设置QQ业务回调,请参考6. 处理QQ业务的回调

5.1 发起QQ临时会话

下面是向指定QQ号码发起临时会话的示例代码:

 

5.2 获取指定QQ号码的在线状态

下面是获取指定QQ号码在线状态的示例代码:

 

6. 处理QQ业务的回调

 

在使用QQApiInterface 的方法时需要设置回调才能正确调用。设置方法如下:

 

在handleOpenURL 中添加[QQApiInterface handleOpenURL:url delegate:(id)[QQAPIDemoEntry class]]代码,可以在QQAPIDemoEntry类中实现QQApiInterfaceDelegate的回调方法。更完整的示例请参考SDKDemo。

7. iOS SDK 腾讯平台开放能力

iOS SDK支持第三方应用成为腾讯业务内容的提供商,要想成为腾讯业务内容提供商需要在QQ互联的官网进行注册
使用SDK响应腾讯业务发起的内容请求可以参考下面的操作:

7.1 修改工程配置文件

在XCode中,选择你的工程设置项,选中“TARGETS”一栏,在“info”标签栏的“URL type”添加一条新的“URL scheme”,新的scheme = tencent + appid+‘.’+ content,identifier“tencentApiIdentifier”为。如果您使用的是XCode3或者更低的版本,则需要在plist文件中添加。Demo中我们注册的appid是222222。如下图

7.2 重写AppDelegate 的handleOpenURL和openURL方法

openURL:

 

handleOpenURL

 

7.3 实现TencentApiInterfaceDelegate协议

响应腾讯业务的请求,需要实现TencentApiInterfaceDelegate协议的两个方法:

 

可以参考以下代码实现对腾讯业务的请求的响应,或参考我们的sample中的代码实现

 

返回顶部