@lx-frontend/wx-authorize
v0.4.3
Published
微信小程序用户授权
Downloads
20
Maintainers
Keywords
Readme
@lx-frontend/wx-authorize
微信小程序发起用户授权过程封装
Description
微信小程序部分接口需要经过用户授权同意才能调用,该工具方法封装了 发起授权请求和引导用户打开授权
的统一流程,适合在调用需授权的接口前发起用户授权或引导用户打开相关授权。
该方法调用后会先校验对应授权所需的系统权限(包括系统开关和应用权限开关),如无对应系统权限会提示引导用户打开相关配置;系统权限校验通过后走小程序授权流程。
小程序授权流程如下:
首次触发弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据,用户同意返回成功,拒绝返回失败。如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。用户之前已经拒绝授权则返回失败并弹出提示引导用户打开授权。
Usage
import wxAuthorize from '@lx-frontend/wx-authorize';
const handleAuth = async () => {
const wxAuthorizeRes = await wxAuthorize('scope.writePhotosAlbum', '没有保存图片到相册的权限,请重新授权');
if (wxAuthorizeRes) {
// 获取授权成功
} else {
// 获取授权失败
}
};
参数说明
wxAuthorize(scope, guidanceContent)
- scope (string):需要获取权限的 scope
- guidanceContent (string):引导用户打开授权时的文案(可选),默认文案为
没有权限,请重新授权
返回结果说明
- 授权成功返回
true
- 授权失败返回
false