Summarize and organize WeChat applet permission interfaces

This article brings you related issues about WeChat Mini Program. It mainly introduces the relevant content of the permission interface in the WeChat Mini Program, including the user authorization interface and obtaining user permission settings. interface, opening the user permission setting interface, etc. Let’s take a look at it together. I hope it will be helpful to everyone.

【Related learning recommendations: 小program learning tutorial】

1. Permission interface

 Some interfaces are required It can be called only after user authorization. We divide these interfaces into multiple scopes according to their usage scope. The user chooses to authorize the scope. After authorizing a scope, all its corresponding interfaces can be used directly. When such interfaces are called:

• If the user does not accept or rejects this permission, a pop-up window will pop up to ask the user, and the user can only call the interface after clicking Unify.
• If the user is authorized, the interface can be called directly.
• If the user has refused authorization, the pop-up window will not appear, but will directly enter the interface fail callback.

 The corresponding relationship between the object scope fields in the permissions of this type of interface and the interface is as shown in the following table.

##scope.userLocationBackgroundwx. startLocationUpdateBackgroundBackground locationscope.recordwx.startRecord, wx.joinVoIPChat, RecorderManager.startMicrophonescope.cameracamera component, wx.createVKSessionCamerascope.bluetoothwx.openBluetoothAdapter, wx.createBLEPeripheralServerBluetoothscope.writePhotosAlbumwx.saveImageToPhotosAlbum, wx.saveVideoToPhotosAlbumAdd to albumscope.addPhoneContactwx.wx.addPhoneContactAdd to contactscope.addPhoneCalendarwx.addPhoneRepeatCalendar, wx.addPhoneCalendarAdd to calendarscope.werunwx. getWeRunDataWeChat exercise stepsscope.addresswx.chooseAddressCorrespondence address (authorization has been cancelled, you can directly Call the corresponding interface) scope.invoiceTitlewx.chooseInvoiceTitleInvoice header (authorization has been cancelled, you can directly call the corresponding interface)scope.invoicewx.chooseInvoiceGet the invoice (authorization has been cancelled, you can directly call the corresponding interface)scope.userInfowx.getUserInfoUser information (the mini program has been recycled, please fill it in with your avatar nickname, and the mini game can continue to be called)

 The mini program provides three sets of interfaces to perform corresponding operations on interface permissions: wx.getSetting()Get the user’s current authorization status; wx.openSetting()Open the setting interface To guide the user to enable authorization; wx.authorize()Change the authorization status.

1.1 User authorization interfacewx.authorize(Object object)

Initiate an authorization request to the user in advance. After calling this interface, a pop-up window will immediately ask the user whether they agree to authorize the applet to use a certain function or obtain some of the user's data, but the corresponding interface will not actually be called. If the user has previously agreed to the authorization, no pop-up window will appear and success will be returned directly. The properties are shown in the table below.

scope	Corresponding interface	Description
scope .userLocation	wx.getLocation, wx.chooseLocation, wx.startLocationUpdate	Geolocation

##NoCallback function that fails to call the interface completefunctionNoThe callback function that ends the interface call (call Both success and failure will be executed)

Attribute	Type	Default value	Required	Description
scope	#string		is the scope that	needs to obtain permissions for. See the scope list for details
success	function		No	The interface call was successful Callback function
fail	function

Sample code from the official website:

// 可以通过 wx.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scopewx.getSetting({
  success(res) {
    if (!res.authSetting['scope.record']) {
      wx.authorize({
        scope: 'scope.record',
        success () {
          // 用户已经同意小程序使用录音功能，后续调用 wx.startRecord 接口不会弹窗询问
          wx.startRecord()
        }
      })
    }
  }})

1.2 Get user permission setting interface

wx.getSetting(Object object)

 This interface obtains the user's current settings. Only the permissions that the applet has requested from the user will appear in the return value. The attributes are as follows:

AttributeTypeDefault valueRequiredDescriptionMinimum version##withSubscriptionssuccessCallback function for successful interface call failfunctionCallback function for failed interface callfunctionNoobject.success callback function is as follows:

Boolean	false	No	Whether to obtain the subscription status of the user's subscription message at the same time, it is not obtained by default. Note: withSubscriptions only returns subscription messages for which the user has checked "Always keep the above selection and never ask again" in the subscription panel.	2.10.1
function		##No
		No			##complete
		The callback function at the end of the interface call (will be executed if the call is successful or failed)

AttributeTypeauthSettingAuthSettingSubscriptionsSettingwithSubscriptionstrueAuthSetting

Description

Minimum version

User authorization result

subscriptionsSetting

User subscription message settings, the interface parameter

will be returned only when the value is

. 2.10.1

miniprogramAuthSetting

When called in the plug-in, the user authorization result of the current host applet

  官网示例代码：

wx.getSetting({
  success (res) {
    console.log(res.authSetting)
    // res.authSetting = {
    //   "scope.userInfo": true,
    //   "scope.userLocation": true
    // }
  }})

1.3 打开用户权限设置接口wx.openSetting(Object object)

  该接口调用客户端小程序设置界面，返回用户设置的操作结果。设置界面只会出现小程序已经向用户请求过的权限。

属性	类型	默认值	必填	说明	最低版本
withSubscriptions	Boolean	false	否	是否同时获取用户订阅消息的订阅状态，默认不获取。注意：withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择，不再询问”的订阅消息。	2.10.3
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success回调函数如下:

属性	类型	说明	最低版本
authSetting	AuthSetting	用户授权结果
subscriptionsSetting	SubscriptionsSetting	用户订阅消息设置，接口参数withSubscriptions值为true时才会返回。	2.10.3

• 注意：2.3.0 版本开始，用户发生点击行为后，才可以跳转打开设置页，管理授权信息。

  官网示例代码：

wx.openSetting({
  success (res) {
    console.log(res.authSetting)
    // res.authSetting = {
    //   "scope.userInfo": true,
    //   "scope.userLocation": true
    // }
  }})

2、授权案例

  本例使用获取地理位置接口wx.getLocation()和开始录音接口wx.startRecord()进行相关操作，而这两个接口都需要设置操作权限。

Setting.wxml代码如下：

<!--index.wxml--><view>获取地理位置</view><view>{{context}}</view><view>开始录音</view>

Setting.js代码如下：

//index.js//获取应用实例const app = getApp()Page({
  data: {
   
  },
  
  onLoad: function () {
    context:''
  },
  location1:function(){	//获取地理位置
    var that=this
    wx.getSetting({	//获取用户权限设置接口
      success(res) {
        console.log(res)
        if (!res.authSetting['scope.userLocation']) {
          wx.authorize({		//授权
            scope: 'scope.userLocation',	//地理位置权限，看线上面的scope对应的参数
            success() {
              wx.getLocation({		//获取当前的地理位置
                success: function(res) {
                 console.log(res)
                  that.setData({ context: "你所在的经度是" + res.latitude+"你所在的纬度是"+res.longitude})
                },
              })
            }
          })
        }
      }
    })
  },
 
  location2: function () {			//录音
    var that = this
  
        wx.getSetting({
          success(res) {
            console.log(res.authSetting)
            if (!res.authSetting['scope.record']) {
              wx.openSetting({		//打开用户权限设置界面
                success(res) {
                  console.log(res)
                  wx.startRecord({		//开始录音
                    success(res) {
                      const tempFilePath = res.tempFilePath
                      console.log("录音结束")
                    }
              })
            } 
        })
        }}
        })
  }})

   location()1函数实现获取地理位置的功能，该函数先调用wx.getSetting()接口获取权限状态，然后调用wx.authorize()接口修改地理位置权限scope.userLocation。location2()函数实现录音功能，该函数先调用wx.getSetting()接口获取权限状态，然后调用wx.openSetting()接口打开录音权限设置界面来修改录音权限。从本例可以看出设置权限的时候应该先调用wx.getSetting()接口来修改权限状态，在没有权限打开的情况下可以调用wx.authorize()接口或者wx.openSetting()接口来修改权限状态，wx.authorize()接口不出现修改权限的操作权限，而wx.openSetting()接口会出现修改权限的操作界面。

  案例效果如下：

  点击获取地理位置：

  点击允许之后会显示当前所在的经纬度。

  点击开始录音按钮出现麦克风授权：

【相关学习推荐：小程序学习教程】

The above is the detailed content of Summarize and organize WeChat applet permission interfaces. For more information, please follow other related articles on the PHP Chinese website!