易信开放平台

还没帐号?

易信iOS平台SDK使用新手指南

本文将介绍SDK的使用。如果你想详细的了解每个API用法,请查阅 API文档 或下载阅读 易信SDK Sample 源码。

一、准备

1. 下载易信客户端,并注册一个易信帐号。
2. 使用易信帐号登录开放平台,转到应用管理页面,添加一个新应用
3. 填写你的应用资料,完成后保存,你会获得一个AppID
iOS平台可立即用该AppID进行开发。审核通过的应用将在内容来源处显示你填写的应用名称,否则显示“未审核应用”。
4. 下载易信SDK
下载的压缩包解压后有三个文件:libYiXinSDK.a, YXApi.h, YXApiObject.h

二、集成

1. 将SDK包含的libYiXinSDK.a, YXApi.h, YXApiObject.h三个文件添加到你的项目中。如图左侧:
2. 在项目设置中选择"Build Setting"标签栏,在"Search Paths"区域中添加 libYiXinSDK.a, YXApi.h, YXApiObject.h三个文件所在的目录。如图:
3. 在项目设置中选择"Info"标签栏,在"URL Types"区域的"URL Schemes"输入框中添加你所获得的AppID。如图:

三、开发

1. 在你需要使用易信API的文件中引入YXApi.h头文件,并增加YXApiDelegate协议。代码如图:
2. 要让易信客户端响应你的应用,需要在你的应用启动时注册AppID。代码如图:
3. 重写handleOpenURLopenURL方法。代码如图:
4. 实现YXApiDelegate协议的两个方法。代码如图:
需要你实现具体的协议方法
5. 你的应用发消息给易信客户端
实例化一个具体的消息,调用sendReq方法,给易信客户端发送消息。SDK将会唤起易信客户端。代码如图:
6. 易信给你的应用发送消息
您实现的onReceiveRequest方法会接收到易信客户端发送给您的请求。请求对象中带有数据,您可以获取请求的具体内容, 以此给用户显示某些信息。 (场景:在易信中点击一则朋友分享给你的新闻消息,会切换到网易新闻客户端并给用户展示该新闻)。代码如图:
7. iOS 9系统策略更新,请开发者注意升级
近期苹果公司iOS 9系统策略更新,应用需要在“Info.plist”中将要使用的URL Schemes列为白名单,才可正常检查其他应用是否安装。受此影响,当你的应用在iOS 9中需要使用易信SDK的相关能力(分享、收藏、登录等)时,需要在“Info.plist”里增加如下代码:
<key>LSApplicationQueriesSchemes</key>
<array>
   <string>yixin</string>
   <string>yixinopenapi</string>
   <string>yixinoauth</string>
   <string>yixinfav</string>
</array>
完成后需使用Xcode 7编译。

附录:对象类型及数据结构

请参考在线文档:开发手册