支付宝小程序API 设置

2020-09-16 15:49 更新

my.getSetting

版本要求:基础库 1.8.0 或更高版本,若版本较低,建议做 兼容处理

获取用户的当前设置,返回值中只会出现小程序已经向用户请求过的权限。

示例代码

my.getSetting({
  success: (res) => {
    /*
     * res.authSetting = {
     *   "location": true,
     *   "audioRecord": true,
     *   ...
     * }
     */
  }
})

入参

Object 类型,属性如下:

属性 类型 必填 说明
success Function 接口调用成功的回调函数,返回内容详见返回参数说明。
fail Function 接口调用失败的回调函数。
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)。

success 回调函数

入参为 Object 类型,属性如下:

属性 类型 说明
authSetting Object 用户授权结果,其中 key 为 scope 值,value 为 Boolean 值,表示用户是否允许授权,详见 scope 列表。

返回值示例

{
    "authSetting": {
        "camera": true,
        "location": true,
        "alipaysports": true,
        "_RVA_APPID": false,
        "aliaddress": true,
        "album": true,
        "userInfo": true,
        "phoneNumber": true
    }
}

scope 列表

scope 对应接口 描述
location my.getLocation 地理位置。
album my.chooseImage,my.saveImage, 保存到相册。
camera my.scan 摄像头。
alipaysports my.getRunData 运动数据。
phoneNumber my.getPhoneNumber 手机号码。
aliaddress my.getAddress 收货地址。
userinfo my.getOpenUserInfo 唤起授权界面,用户可以授权小程序获取支付宝会员的基础信息 。
_RVA_APPID - 此参数无意义。

my.openSetting

版本要求:基础库 1.8.0 或更高版本,若版本较低,建议做 兼容处理

打开小程序设置界面,返回用户权限设置的结果;设置界面只会出现小程序已经向用户请求过的权限。

示例代码

my.openSetting({
  success: (res) => {
    /*
     * res.authSetting = {
     *   "userInfo": true,
     *   "location": true,
     *   ...
     * }
     */
  }
})

入参

Object 类型,属性如下:

属性 类型 必填 说明
success Function 接口调用成功的回调函数,返回内容详见返回参数说明。
fail Function 接口调用失败的回调函数。
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)。

success 回调函数

入参为 Object 类型,属性如下:

参数 类型 说明
authSetting Object 用户授权结果,其中 key 为 scope 值,value 为 Bool 值,表示用户是否允许授权,详见下面的 scopes 列表。

scopes 列表
scopes 对应接口 描述
location my.getLocation 地理位置。
album my.chooseImage、my.saveImage 保存到相册。
camera my.scan 摄像头。
userInfo my.getOpenUserInfo 唤起授权界面,用户可以授权小程序获取支付宝会员的基础信息。
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号