已定稿
感谢DCloud等1人做出了贡献
常见问题 我要提意见 赞(173)

OAuth

OAuth模块管理客户端的用户授权登录验证功能,允许应用访问第三方平台的资源。

方法:

对象:

回调方法:

getServices

获取授权登录认证服务列表

void plus.oauth.getServices( successCB, errorCB );

说明:

获取终端支持的权登录认证服务列表,可用于提示用户进行登录平台的选择。获取授权登录认证服务成功后通过successCB回调返回支持的所有服务列表,获取服务失败则通过errorCB回调返回失败信息。

参数:

返回值:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

示例:

<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8"/>
	<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
	<title>OAuth Example</title>
	<script type="text/javascript">
var auths=null;
// 监听plusready事件  
document.addEventListener( "plusready", function(){
	// 扩展API加载完毕,现在可以正常调用扩展API
	plus.oauth.getServices( function(services){
		auths = services;
	}, function(e){
		alert( "获取分享服务列表失败:"+e.message+" - "+e.code );
	} );
}, false );
	</script>
	</head>
	<body>
		获取授权登录认证服务列表
	</body>
</html>

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中为对象,用于向系统进行授权登录认证操作。

方法:

属性:

login

请求授权登录认证操作

void obj.login( successCallback, errorCallback, options );

说明:

对指定的授权登录认证服务进行登录认证操作,在登录前可通过对象的authResult属性判断是否已经登录认证过,通常只需要对没有进行过登录认证的服务进行登录认证操作。授权认证操作成功后通过successCB回调函数通知,失败则通过errorCB回调函数通知。

参数:

返回值:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

示例:

<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8"/>
	<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
	<title>OAuth Example</title>
	<script type="text/javascript">
var auths=null;
// 监听plusready事件  
document.addEventListener( "plusready", function(){
	// 扩展API加载完毕,现在可以正常调用扩展API
	plus.oauth.getServices( function(services){
		auths = services;
	}, function(e){
		alert( "获取分享服务列表失败:"+e.message+" - "+e.code );
	} );
}, false );
// 登录操作
function authLogin(){
	var s = auths[0];
	if ( !s.authResult ) {
		s.login( function(e){
			alert( "登录认证成功!" );
		}, function(e){
			alert( "登录认证失败!" );
		} );
	}else{
		alert( "已经登录认证!" );
	}
}
	</script>
	</head>
	<body>
		1.请求授权登录认证操作<br/>
		<button onclick="authLogin()">Login</button>
	</body>
</html>

logout

注销授权登录认证

void obj.logout( successCallback, errorCallback );

说明:

对指定的授权登录认证服务注销登录认证操作,注销授权认证后,再次操作时需重新进行登录认证操作。 如果第三方平台不需要注销操作,则情况保存的相关登录认证等信息。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8"/>
	<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
	<title>OAuth Example</title>
	<script type="text/javascript">
var auths=null;
// 监听plusready事件  
document.addEventListener( "plusready", function(){
	// 扩展API加载完毕,现在可以正常调用扩展API
	plus.oauth.getServices( function(services){
		auths = services;
	}, function(e){
		alert( "获取分享服务列表失败:"+e.message+" - "+e.code );
	} );
}, false );
// 登录操作
function authLogin(){
	var s = auths[0];
	if ( !s.authResult ) {
		s.login( function(e){
			alert( "登录认证成功!" );
		}, function(e){
			alert( "登录认证失败!" );
		} );
	}else{
		alert( "已经登录认证!" );
	}
}
// 注销所有授权登录认证服务
function authLogout(){
	for ( var i in auths ) {
		var s = auths[i];
		if ( s.authResult ) {
			s.logout(function(e){
				alert( "注销登录认证成功!" );
			}, function(e){
				alert( "注销登录认证失败!" );
			});
		}
	}
}
	</script>
	</head>
	<body>
		1.请求授权登录认证操作<br/>
		<button onclick="authLogin()">Login</button>
		2.请求授权登录认证操作<br/>
		<button onclick="authLogout()">Logout</button>
	</body>
</html>

getUserInfo

获取授权登录用户信息

void obj.getUserInfo( successCallback, errorCallback );

说明:

获取授权登录认证的用户信息,在获取前可通过对象的userInfo属性判断是否已经获取过,通常只需要对没有获取过用户信息的服务进行操作。 获取用户信息操作成功后通过successCallback回调函数通知,失败则通过errorCallback回调函数通知。

参数:

返回值:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

示例:

<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8"/>
	<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
	<title>OAuth Example</title>
	<script type="text/javascript">
var auths=null;
// 监听plusready事件  
document.addEventListener( "plusready", function(){
	// 扩展API加载完毕,现在可以正常调用扩展API
	plus.oauth.getServices( function(services){
		auths = services;
	}, function(e){
		alert( "获取分享服务列表失败:"+e.message+" - "+e.code );
	} );
}, false );
// 登录操作
function authLogin(){
	var s = auths[0];
	if ( !s.authResult ) {
		s.login( function(e){
			alert( "登录认证成功!" );
		}, function(e){
			alert( "登录认证失败!" );
		} );
	}else{
		alert( "已经登录认证!" );
	}
}
// 获取登录用户信息操作
function authUserInfo(){
	var s = auths[0];
	if ( !s.authResult ) {
		alert("未授权登录!");
	} else {
		s.getUserInfo( function(e){
			alert( "获取用户信息成功:"+JSON.stringify(s.userInfo) );
		}, function(e){
			alert( "获取用户信息失败:"+e.message+" - "+e.code );
		} );
	}
}
	</script>
	</head>
	<body>
		1.请求授权登录认证操作<br/>
		<button onclick="authLogin()">Login</button>
		2. 获取授权登录用户信息<br/>
		<button onclick="authUserInfo()">UserInfo</button>
	</body>
</html>

AuthOptions

JSON对象,授权认证参数选项

interface plus.oauth.AuthOptions {
	attribute String scope;
	attribute String state;
	attribute String appkey;
}

说明:

此对象支持的属性值由授权登录认证服务定义。 例如“微信”,则可配置以下参数: scope - 应用授权作用域; state - 用于保持请求和回调的状态参数。

属性:

ServicesSuccessCallback

获取授权登录认证服务成功回调

void ServicesSuccessCallback( services ) {
	// Get oauth services success code
}

说明:

当获取授权登录认证服务列表成功时触发,并通过services参数返回运行环境支持的授权登录认证服务列表。

参数:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

AuthLogoutSuccessCallback

注销授权登录认证操作成功回调函数

void AuthLogoutSuccessCallback( event ) {
	  // logout code
}

说明:

注销授权登录认证成功时触发,并返回操作结果。

参数:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

AuthSuccessCallback

授权登录认证服务操作成功回调函数

void AuthSuccessCallback( event ) {
	  // auth code
}

说明:

授权登录认证服务操作如请求授权登录认证、获取授权登录用户信息成功时触发,并返回操作结果。

参数:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL

AuthErrorCallback

授权登录认证服务操作失败回调函数

void AuthErrorCallback( error ) {
	// Error code
}

说明:

授权登录认证服务操作如请求授权登录认证、注销授权登录认证、获取授权登录用户信息失败时触发,并返回错误信息。

参数:

平台支持:

Android : 2.2+

iOS : 5.0+

360-Light : ALL