首页 > API文档 > JavaScript API
容器
更新时间: 2021-12-08 12:03:05

容器

接口名接口描述
runtime.getVersion获取终端版本号
runtime.getCurrentUser获取当前用户信息
runtime.requestAuthCode获取临时授权码用于免登业务
runtime.showUpdate提示版本升级

获取终端版本号

代码样例

FSOpen.runtime.getVersion({
    onSuccess: function(resp){
        alert('当前终端版本号是:' + resp.ver);
    },
    onFail: function(error){
        alert('接口调用失败,错误码:' + error.errorCode);
    }
});

方法名:FSOpen.runtime.getVersion
JS版本:2.0.0
客户端支持版本:5.4.0及以上

成功回调返回参数:

参数类型说明
verString版本号信息,如'5.3.0'。

获取当前用户信息

代码样例

FSOpen.runtime.getCurrentUser({
    onSuccess: function(resp){
        alert('当前用户信息:' + JSON.stringify(resp));
    },
    onFail: function(error){
        alert('接口调用失败,错误码:' + error.errorCode);
    }
});

方法名:FSOpen.runtime.getCurrentUser
JS版本:2.0.0
客户端支持版本:5.4.0及以上

成功回调返回参数:

参数类型说明
userObject返回当前用户的具体信息,详细字段如下表所示。

user对象参数说明:

参数类型说明
userIdString用户ID
nicknameString用户昵称
emailString用户电子邮箱
avatarUrlString用户头像
positionString用户职位信息

获取免登授权码

免登授权码主要用于通过服务器接口换取用户身份(用户ID),参考身份验证接口

代码样例

FSOpen.runtime.requestAuthCode({
    onSuccess: function(resp) {
        alert('免登授权码信息:' + JSON.stringify(resp));
    },
    onFail: function(error) {
        alert('接口调用失败,错误码:' + error.errorCode);
    }
});

方法名:FSOpen.runtime.requestAuthCode
JS版本:2.0.0
客户端支持版本:5.4.0及以上

成功回调返回参数:

参数类型说明
codeString免登授权码,主要用于通过服务器接口换取用户身份。

客户端同时提供一个更为便捷的JS API,可直接获取到当前用户信息,请参考接口获取当前用户信息 FSOpen.runtime.getCurrentUser

提示版本升级

弹出升级提示,在Android上用户点击确定后可跳转到应用市场直接升级。

代码样例

FSOpen.runtime.showUpdate({
    message: '当前版本有更新。'
});

方法名:FSOpen.runtime.showUpdate
JS版本:2.0.0
客户端支持版本:5.4.0及以上

调用参数说明:

参数类型必须说明
messageString升级提示文本