YXApi类 参考

易信Api接口函数 更多...

#import <YXApi.h>

类 YXApi 继承关系图:

Class Methods
(BOOL)	+ registerApp:
	注册第三方App到易信客户端。 更多...
(BOOL)	+ isYXAppInstalled
	检查易信客户端是否已安装 更多...
(BOOL)	+ isYXAppSupportApi
	判断当前易信客户端的版本是否支持易信分享 更多...
(BOOL)	+ isYXAppSupportOAuth
	判断当前易信客户端的版本是否支持OAuth授权 更多...
(BOOL)	+ isYXAppSupportFav
	判断当前易信客户端的版本是否支持收藏到易信功能 更多...
(BOOL)	+ openYXApp
	打开易信客户端 更多...
(BOOL)	+ handleOpenURL:delegate:
	第三方App被易信客户端通过URL唤起时的调用 更多...
(BOOL)	+ sendReq:
	发送请求消息到易信客户端。 更多...
(BOOL)	+ sendResp:
	发送应答消息给易信客户端，并唤起易信客户端 更多...
(void)	+ showWebViewToOauth:::
	使用webview进行授权认证流程 更多...

详细描述

易信Api接口函数

易信SDK的所有接口函数

Method Documentation

+ (BOOL) handleOpenURL:		(NSURL *)	url
delegate:		(id< YXApiDelegate >)	delegate

第三方App被易信客户端通过URL唤起时的调用

需要在 application:openURL:sourceApplication:annotation:或者application:handleOpenURL中调用。

参数

url	启动第三方App的URL
delegate	YXApiDelegate对象，用来接收易信客户端触发的消息。

返回

成功返回YES，失败返回NO。

+ (BOOL) isYXAppInstalled

检查易信客户端是否已安装

返回

易信已安装返回YES，未安装返回NO。

+ (BOOL) isYXAppSupportApi

判断当前易信客户端的版本是否支持易信分享

返回

支持返回YES，不支持返回NO。

+ (BOOL) isYXAppSupportFav

判断当前易信客户端的版本是否支持收藏到易信功能

返回

支持返回YES，不支持返回NO。

+ (BOOL) isYXAppSupportOAuth

判断当前易信客户端的版本是否支持OAuth授权

返回

支持返回YES，不支持返回NO。

+ (BOOL) openYXApp

打开易信客户端

返回

成功返回YES，失败返回NO。

+ (BOOL) registerApp:

(NSString *)

appID

注册第三方App到易信客户端。

启动三方App程序时调用，第一次调用后会在易信客户端的可用应用列表中出现。

参数

appID

易信开放平台注册的开发者ID

返回

成功返回YES，失败返回NO。

+ (BOOL) sendReq:

(YXBaseReq *)

req

发送请求消息到易信客户端。

发送消息后，会唤起易信客户端；第三方应用程序等待易信返回响应消息。 可能发送的请求有 SendMessageToYXReq等。

参数

req	请求事件消息的对象，在调用函数后，请自己释放。

返回

成功返回YES，失败返回NO。

+ (BOOL) sendResp:

(YXBaseResp *)

resp

发送应答消息给易信客户端，并唤起易信客户端

函数调用后，会切换到易信的界面。可能发送的相应有 GetMessageFromYXResp、ShowMessageFromYXResp等。

参数

resp	应答事件消息的对象，调用函数后，请自己释放

返回

成功返回YES，失败返回NO。

+ (void) showWebViewToOauth:		(SendOAuthToYXReq *)	redirectURL
:		(NSString *)	delegate
:		(id< YXApiDelegate >)	delegate

使用webview进行授权认证流程

函数调用后，会弹出webview界面完成易信登录进行授权认证流程。可能发送的相应有 GetMessageFromYXResp、ShowMessageFromYXResp等。

参数

resp	OAuth请求消息的对象，调用函数后，请自己释放。
redirectURL	你得应用在易信开放平台注册时提供的OAuth认证完成之后的回调url。

---

该类的文档由以下文件生成:

• YXApi.h