my.getSetting

Property	Type	Required	Description
success	Function	No	Callback on success
fail	Function	No	Callback on failure
complete	Function	No	Callback that always executes

Property

Type

Required

Description

success

Function

Callback on success

fail

Function

Callback on failure

complete

Function

Callback that always executes

Property	Type	Description
authSetting	Object	Results of user authorization. Keys are the values of scopes and values are boolean types, which shows whether the user gives the permission or not.

Property

Type

Description

authSetting

Object

Results of user authorization. Keys are the values of scopes and values are boolean types, which shows whether the user gives the permission or not.

Scopes

Scope	API	Description
location	my.getLocation	Specifies whether to authorize access to geographic location.
album	my.chooseImage, my.saveImage	Specifies whether to authorize saving images to the album.
camera	my.scan	Specifies whether to authorize access to the camera.
phoneNumber	my.getPhoneNumber	Specifies whether to authorize access to the phone number.
userInfo	my.getOpenUserInfo	Specifies whether to authorize access to user information.

Code Example

my.getSetting({
  success: (res) => {
    console.log('Auth settings:', res.authSetting);
    // Example: { location: true, camera: false, album: true, userInfo: true, phoneNumber: true }
    if (res.authSetting['location']) {
      // Location permission already granted
    }
  },
  fail: (err) => {
    console.error('Failed to get settings:', err);
  }
});

Guide users to grant permissions

JSAPI Reference

Basic

In-App Events

UI

Media

Storage

File

Location

Map

Network

Device

Sharing

Collection

Update

Web View

Alipay Connect

Open Capabilities

Other

Parameters

Success Callback Parameters

Scopes

Code Example

my.openSetting

my.showAuthGuide

​Parameters

​Success Callback Parameters

​Scopes

​Code Example

​Related APIs

my.openSetting

my.showAuthGuide

Parameters

Success Callback Parameters

Scopes

Code Example

Related APIs