@tarojs/taro/types/api/open-api/authorize.d.ts

Taro framework

import Taro from '../../index'

declare module '../../index' {
  namespace authorizeForMiniProgram {
    interface Option {
      /** 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) */
      scope: keyof Scope | string
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: TaroGeneral.CallbackResult) => void
    }

    /** scope 合法值
     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8
     */
    interface Scope {
      'scope.record'
      'scope.writePhotosAlbum'
      'scope.camera'
    }
  }

  namespace authorize {
    interface Option {
      /** 需要获取权限的 scope，详见 [scope 列表](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html#scope-%E5%88%97%E8%A1%A8) */
      scope: string
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: TaroGeneral.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: TaroGeneral.CallbackResult) => void
    }
  }

  interface TaroStatic {
    /** **仅小程序插件中能调用该接口**，用法同 [Taro.authorize](../authorize)。目前仅支持三种 scope
     * @supported weapp
     * @example
     * ```tsx
     * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
     * Taro.authorizeForMiniProgram({
     *   scope: 'scope.record',
     *   success () {
     *     // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问
     *     Taro.startRecord()
     *   }
     * })
     * ```
     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorizeForMiniProgram.html
     */
     authorizeForMiniProgram(option: authorizeForMiniProgram.Option): Promise<TaroGeneral.CallbackResult>

    /** 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html)。
     * @supported weapp, swan, qq, tt, rn
     * @example
     * ```tsx
     * // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
     * Taro.getSetting({
     *   success: function (res) {
     *     if (!res.authSetting['scope.record']) {
     *       Taro.authorize({
     *         scope: 'scope.record',
     *         success: function () {
     *           // 用户已经同意小程序使用录音功能，后续调用 Taro.startRecord 接口不会弹窗询问
     *           Taro.startRecord()
     *         }
     *       })
     *     }
     *   }
     * })
     * ```
     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/authorize/wx.authorize.html
     */
     authorize(option: authorize.Option): Promise<TaroGeneral.CallbackResult>
  }
}