vk

概述

插件封装了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 平台配置方法:

  • 配置示例:

<preference name="querySchemes" value="vkauthorize" />
<feature name="vk">
    <param name="urlScheme" value="vk7363554" />
</feature>

接口

init

vk初始化

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

appid:

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

scope:

  • 类型:数组类型
  • 描述:需要获取的信息权限
[
 'notify',         //可选项
 'friends',        //可选项
 'photos',         //可选项
 'audio',          //可选项
 'video',          //可选项
 'docs',           //可选项
 'notes',          //可选项
 'pages',          //可选项
 'status',         //可选项
 'wall',           //可选项
 'groups',         //可选项
 'messages',       //可选项
 'notifications',  //可选项
 'stats',          //可选项
 'ads',            //可选项
 'offline',        //可选项
 'nohttps',        //可选项(仅iOS支持)
 'email',          //可选项
 'market'          //可选项
]

callback(ret)

ret:

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

示例代码

    var name = api.require('vk');
    name.init({
              appid:'3974615',
              scope:['audio','friends','wall','photos']
    }, function(ret) {
        if (ret) {
           api.alert({
            msg: JSON.stringify(ret)
        })
        }
    });

可用性

iOS系统、android系统

可提供的1.0.0及更高版本

login

vk登陆

login(callback(ret,err))

callback(ret)

ret:

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

    status:true       //布尔类型;是否正常开启,
    
    result:            //JSON对象;仅支持iOS
    
    accessToken:'',     //字符串类型;仅支持安卓
    created',         //数字类型;仅支持安卓
    email:'',           //字符串类型;仅支持安卓
    phone:'',          //字符串类型;仅支持安卓
    phoneAccesKey:'',    //字符串类型;仅支持安卓
    secret:'',               //字符串类型;仅支持安卓
    userId:,               //数字类型;仅支持安卓
    isValid:,               //布尔类型;仅支持安卓
}

err:

  • 类型:JSON对象
  • 内部字段:
{
code:,           //数字类型;错误码
msg:'',           //字符串类型;错误信息
}

示例代码

var vk = api.require('vk');    	
vk.login({
},
     function(ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

isLoggedIn

是否已登陆(

isLoggedIn(callback(ret,err))

callback(ret)

ret:

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

    status:true       //布尔类型;是否正常开启, (仅android支持)
    isLoggedIn:,      //布尔类型;是否登陆
}

err:

  • 类型:JSON对象
  • 内部字段:
{
msg:'',           //字符串类型;错误信息 (仅android支持)
}

示例代码

var vk = api.require('vk');    	
vk.isLoggedIn({
},
     function(ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

Android系统

可提供的1.0.0及更高版本

getFinger

获取finger(仅android支持)

getFinger(callback(ret,err))

callback(ret)

ret:

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

    status:true       //布尔类型;是否正常开启,
    finger:[],      //数组类型;finger
}

err:

  • 类型:JSON对象
  • 内部字段:
{
msg:'',           //字符串类型;错误信息
}

示例代码

var vk = api.require('vk');    	
vk.getFinger({
},
     function(ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

Android系统

可提供的1.0.0及更高版本

tokenExpiredListener

token过期监听(仅android支持)

tokenExpiredListener(callback(ret,err))

callback(ret)

ret:

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

    status:true       //布尔类型;是否正常开启,
    action:‘’,      //字符串类型:事件
                                ‘tokenExpired’:token过期
}

err:

  • 类型:JSON对象
  • 内部字段:
{
msg:'',           //字符串类型;错误信息
}

示例代码

var vk = api.require('vk');    	
vk.tokenExpiredListener({
},
     function(ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

Android系统

可提供的1.0.0及更高版本

share

vk分享

share({params}, callback(ret))

text:

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

img:

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

ownerId:

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

friendsOnly:

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

fromGroup:

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

callback(ret,err)

ret:

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

err:

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

示例代码

    var name = api.require('vk');
    name.share({
               img:['widget://res/car14.png',
                    'widget://res/car14.png',
                    'widget://res/car14.png',
                    'widget://res/car14.png',
                    ]
               
               text:'https://www.baidu.com/https://www'
    }, function(ret) {
        if (ret) {
           api.alert({
            msg: JSON.stringify(ret)
        })
        }
    });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/04/8