html5plus OAuth模块管理客户端的用户授权登录验证功能
摘要:html5plus OAuth模块管理客户端的用户授权登录验证功能
oauth
OAuth模块管理客户端的用户授权登录验证功能,允许应用访问第三方平台的资源。
方法:
- getServices: 获取授权登录认证服务列表
对象:
- AuthService: 授权登录认证服务对象
- AuthOptions: JSON对象,授权认证参数选项
回调方法:
- ServicesSuccessCallback: 获取授权登录认证服务成功回调
- AuthSuccessCallback: 授权登录认证服务操作成功回调函数
- AuthLogoutSuccessCallback: 注销授权登录认证操作成功回调函数
- AuthErrorCallback: 授权登录认证服务操作失败回调函数
权限:
permissions
"OAuth": { "description": "访问授权登录认证插件" }
AuthService
授权登录认证服务对象
interface plus.oauth.AuthService { // Attributes attribute String id; attribute String description; attribute JSON authResult; attribute JSON userInfo; attribute JSON extra; // Methods function void login( successCallback, errorCallback, options ); function void logout( successCallback, errorCallback ); function void getUserInfo( successCallback, errorCallback ); }
说明:
AuthService对象用于表示授权登录认证服务,在JS中为对象,用于向系统进行授权登录认证操作。
属性:
- id: 授权登录认证服务标识
- description: 授权登录认证服务描述
- authResult: 授权认证结果数据
- userInfo: 授权登录认证用户信息
- extra: 授权登录认证扩展信息
方法:
- login: 请求授权登录认证操作
- logout: 注销授权登录认证
- getUserInfo: 获取授权登录用户信息
AuthOptions
JSON对象,授权认证参数选项
interface plus.oauth.AuthOptions { attribute String scope; attribute String state; }
说明:
此对象支持的属性值由授权登录认证服务定义。 例如“微信”,则可配置以下参数: appid - 应用唯一标识,在微信开放平台提交应用审核通过后获得; scope - 应用授权作用域; state - 用于保持请求和回调的状态参数。
属性:
-
scope: (String 类型 )申请的权限范围
-
state: (String 类型 )客户端的当前状态,可以指定任意值,登录认证后原封不动的返回保存到AuthService对象的extra中
ServicesSuccessCallback
获取授权登录认证服务成功回调
void ServicesSuccessCallback( services ) { // Get oauth services success code }
说明:
当获取授权登录认证服务列表成功时触发,并通过services参数返回运行环境支持的授权登录认证服务列表。
参数:
-
services: ( Array[ AuthService ] ) 必选 运行环境支持的授权登录认证服务列表
运行环境支持的授权登录认证服务列表数组,可通过services.length获取服务列表的数目。 如果当前运行环境没有支持的授权登录认证服务,则返回空数组。
返回值:
void : 无AuthSuccessCallback
授权登录认证服务操作成功回调函数
void AuthSuccessCallback( event ) { // auth code }
说明:
授权登录认证服务操作如请求授权登录认证、获取授权登录用户信息成功时触发,并返回操作结果。
参数:
-
event: ( JSON ) 必选 授权登录认证服务操作回调事件参数
包括以下参数: event.target - 表示授权登录认证服务对象,可以通过此对象的authResult、userInfo属性来获取操作结果信息。
返回值:
void : 无AuthLogoutSuccessCallback
注销授权登录认证操作成功回调函数
void AuthLogoutSuccessCallback( event ) { // logout code }
说明:
注销授权登录认证成功时触发,并返回操作结果。
参数:
-
event: ( JSON ) 必选 注销授权登录认证操作回调事件参数
包括以下参数: event.target - 表示授权登录认证服务对象; 其它属性可保存注销授权登录的扩展数据。
返回值:
void : 无AuthErrorCallback
授权登录认证服务操作失败回调函数
void AuthErrorCallback( error ) { // Error code }
说明:
授权登录认证服务操作如请求授权登录认证、注销授权登录认证、获取授权登录用户信息失败时触发,并返回错误信息。
参数:
-
error: ( Exception ) 必选 操作失败错误信息
包括以下参数: error.code - 表示错误代码; error.message - 错误描述信息;
返回值:
void : 无相关文章
最新发布
阅读排行
热门文章
猜你喜欢