vk

立即使用

init login share isLoggedIn getFinger tokenExpiredListener

概述

模块封装了vk的三方登陆分享功能。

使用前配置

android配置appId:

(1) 下载 vkAppendix模块zip包并解压(解压后会看到一个vkAppendix文件夹) (2) 将文件夹中的vk-Appendex.aar修改后缀为.zip并解压 (3) 打开文件res\values\values (3) 用vk平台获取的appid替换文档中【your appid】字段 (4)将vkAppendix文件夹重新打为zip包,以自定义模块方式添加到工程

配置 config.xml 文件:

针对 ios 平台配置方法:

  • 配置示例:
  1. <preference name="querySchemes" value="vkauthorize" />
  2. <feature name="vk">
  3. <param name="urlScheme" value="vk7363554" />
  4. </feature>

接口

init

vk初始化

init({params}, callback(ret, err))

appid:

  • 类型:字符串类型
  • 描述:开发者注册的AppID(仅iOS支持)

scope:

  • 类型:数组类型
  • 描述:需要获取的信息权限
  1. [
  2. 'notify', //可选项
  3. 'friends', //可选项
  4. 'photos', //可选项
  5. 'audio', //可选项
  6. 'video', //可选项
  7. 'docs', //可选项
  8. 'notes', //可选项
  9. 'pages', //可选项
  10. 'status', //可选项
  11. 'wall', //可选项
  12. 'groups', //可选项
  13. 'messages', //可选项
  14. 'notifications', //可选项
  15. 'stats', //可选项
  16. 'ads', //可选项
  17. 'offline', //可选项
  18. 'nohttps', //可选项(仅iOS支持)
  19. 'email', //可选项
  20. 'market' //可选项
  21. ]

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true //布尔类型;是否成功
  3. type: //字符串类型;status为true时有值(仅iOS支持)
  4. - AuthorizationUnknown //Authorization state unknown, probably ready to work or something went wrong
  5. - AuthorizationInitialized //SDK initialized and ready to authorize
  6. - AuthorizationPending //Authorization state pending, probably we're trying to load auth information
  7. - AuthorizationExternal //Started external authorization process
  8. - AuthorizationSafariInApp //Started in app authorization process, using SafariViewController
  9. - AuthorizationWebview //Started in app authorization process, using webview
  10. - AuthorizationAuthorized //User authorized
  11. - AuthorizationError //An error occured, try to wake up session later
  12. }

示例代码

  1. var name = api.require('vk');
  2. name.init({
  3. appid:'3974615',
  4. scope:['audio','friends','wall','photos']
  5. }, function(ret) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. }
  9. });

可用性

iOS系统、android系统

可提供的1.0.0及更高版本

login

vk登陆

login(callback(ret,err))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true //布尔类型;是否正常开启,
  3. result: //JSON对象;仅支持iOS
  4. accessToken:'', //字符串类型;仅支持安卓
  5. created', //数字类型;仅支持安卓
  6. email:'', //字符串类型;仅支持安卓
  7. phone:'', //字符串类型;仅支持安卓
  8. phoneAccesKey:'', //字符串类型;仅支持安卓
  9. secret:'', //字符串类型;仅支持安卓
  10. userId:, //数字类型;仅支持安卓
  11. isValid:, //布尔类型;仅支持安卓
  12. }

err:

  • 类型:JSON对象
  • 内部字段:

    1. {
    2. code:, //数字类型;错误码
    3. msg:'', //字符串类型;错误信息
    4. }

    示例代码

  1. var vk = api.require('vk');
  2. vk.login({
  3. },
  4. function(ret) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

isLoggedIn

是否已登陆(

isLoggedIn(callback(ret,err))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true //布尔类型;是否正常开启, (仅android支持)
  3. isLoggedIn:, //布尔类型;是否登陆
  4. }

err:

  • 类型:JSON对象
  • 内部字段:

    1. {
    2. msg:'', //字符串类型;错误信息 (仅android支持)
    3. }

    示例代码

  1. var vk = api.require('vk');
  2. vk.isLoggedIn({
  3. },
  4. function(ret) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

getFinger

获取finger(仅android支持)

getFinger(callback(ret,err))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true //布尔类型;是否正常开启,
  3. finger:[], //数组类型;finger
  4. }

err:

  • 类型:JSON对象
  • 内部字段:

    1. {
    2. msg:'', //字符串类型;错误信息
    3. }

    示例代码

  1. var vk = api.require('vk');
  2. vk.getFinger({
  3. },
  4. function(ret) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

tokenExpiredListener

token过期监听(仅android支持)

tokenExpiredListener(callback(ret,err))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status:true //布尔类型;是否正常开启,
  3. action:‘’, //字符串类型:事件
  4. tokenExpired’:token过期
  5. }

err:

  • 类型:JSON对象
  • 内部字段:

    1. {
    2. msg:'', //字符串类型;错误信息
    3. }

    示例代码

  1. var vk = api.require('vk');
  2. vk.tokenExpiredListener({
  3. },
  4. function(ret) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

share

vk分享

share({params}, callback(ret))

text:

  • 类型:字符串类型
  • 描述:分享的内容

img:

  • 类型:数组类型
  • 描述:分享的图片
  1. [
  2. 'widget://res/img.png', //图片路径;支持(widget://、fs://)
  3. 'widget://res/img.png'
  4. ]

ownerId:

  • 类型:数字类型
  • 描述:(可选项)ownerId(仅android支持)

friendsOnly:

  • 类型:布尔类型
  • 描述:(可选项)仅朋友(仅android支持)
  • 默认值:false

fromGroup:

  • 类型:布尔类型
  • 描述:(可选项)fromGroup(仅android支持)
  • 默认值:false

callback(ret,err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. type: //字符串类型;
  3. - 'cancle' //取消(仅iOS支持)
  4. - 'done' //完成
  5. - error // 失败(仅android支持)
  6. code:, //数字类型;当type为done返回(仅android支持)
  7. }

err:

  • 类型:JSON 对象
  • 内部字段:(仅android支持)
  1. {
  2. msg:'', //字符串类型;失败原因
  3. }

示例代码

  1. var name = api.require('vk');
  2. name.share({
  3. img:['widget://res/car14.png',
  4. 'widget://res/car14.png',
  5. 'widget://res/car14.png',
  6. 'widget://res/car14.png',
  7. ]
  8. text:'https://www.baidu.com/https://www'
  9. }, function(ret) {
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. }
  13. });

可用性

Android、iOS系统

可提供的1.0.0及更高版本