Alipay Mini Program

https://opendocs.alipay.com/mini
Admin
Alipay Mini Program provides a platform and resources for developers to build, manage, and promote...
Tokens:1,000,972
Snippets:8,389
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Launch Options

Source: https://opendocs.alipay.com/mini/api/getLaunchOptionsSync

Retrieves the cold start parameters and logs them to the console.

```javascript
const options = my.getLaunchOptionsSync();
console.log(options);
```

```json
{
    "apiCategory": "default",
    "path": "pages/index/index",
    "referrerInfo": {},
    "query": {
        "key": "222"
    },
    "scene": "1011"
}
```

--------------------------------

### Basic usage of my.showAuthGuide

Source: https://opendocs.alipay.com/mini/006lk2

A simple example showing how to trigger the authorization guide for location services.

```javascript
my.showAuthGuide({
  authType: "LBS"
});
```

--------------------------------

### Conditional permission guidance

Source: https://opendocs.alipay.com/mini/038rnz

Examples demonstrating how to check system status before guiding the user, or how to handle API failures by triggering the guide.

```javascript
Page({
  getLocationExample1() {
    my.getSystemInfo({
      success(res) {
        if (res.locationEnabled && res.locationAuthorized) {
          my.getLocation({
            complete: (res) => my.alert({ title: "getLocation compete", content: JSON.stringify(res)}),
          });
        } else {
          console.log(`${res.locationEnabled} ？ "定位权限未授予支付宝" : "定位功能未开启"`);
          my.showAuthGuide({ authType: "LBS" });
        }
      }
    });
  },
});
```

```javascript
Page({
  getLocationExample2() {
    my.getLocation({
      success: (res) => my.alert({ title: "getLocation success", content: JSON.stringify(res) }),
      fail: (res) => {
        if (res.error == 11) {
          console.error("定位功能未开启或定位权限未授予支持宝");
          my.showAuthGuide({ authType: "LBS" });
        } else {
          console.error('getLocation failed: ', JSON.stringify(res));
        }
      }
    });
  },
});
```

--------------------------------

### Get Cold Start Parameters

Source: https://opendocs.alipay.com/mini/037zgy

Call my.getLaunchOptionsSync() to obtain the parameters passed when the mini program was launched cold. This function is suitable for initial launch data.

```javascript
const options = my.getLaunchOptionsSync();
console.log(options);
```

--------------------------------

### Login Configuration File Examples

Source: https://opendocs.alipay.com/mini/089cbt

Examples of JSON and YAML configuration files used for CloudPiloT authentication.

```json
{
  "appid": "your_appid",
  "private_key": "your_private_key"
}
```

```yaml
appid: "your_appid"
private_key: "your_private_key"
```

--------------------------------

### Accelerometer Control Implementation

Source: https://opendocs.alipay.com/mini/006lib

Example demonstrating how to start and stop accelerometer monitoring, as well as how to manage event listeners in an Alipay mini program.

```axml
<view>
  <button size="default" type="primary" onTap="start">开始监听</button>
  <button size="default" style="margin-top: 30rpx;" type="primary" onTap="stop">停止监听</button>
  <button size="default" style="margin-top: 30rpx;" type="primary" onTap="offSingle">移除单个</button>
</view>
```

```js
Page({
    listener(res) {
      console.log("1" + JSON.stringify(res))
    },
    listener2(res) {
      console.log("2" + JSON.stringify(res));
    },
    start() {
      my.startAccelerometer({
        success: () => {
          my.onAccelerometerChange(this.listener);
          my.onAccelerometerChange(this.listener2);
        }
      });
    },
    stop() {
      my.stopAccelerometer();
    },
    offSingle() {
      my.offAccelerometerChange(this.listener);
    }
});
```

--------------------------------

### Transaction Usage Example

Source: https://opendocs.alipay.com/mini/08o1ea

A practical example demonstrating how to use startTransaction to handle an order creation and balance deduction process atomically.

```JavaScript
const cloud = require("@alipay/faas-server-sdk");
  

exports.main = async (event, context) => {
const db = cloud.database();
try {
const transaction = await db.startTransaction();
const orderCollection = transaction.collection('order');
const accountCollection = transaction.collection('account');
const account = await accountCollection.doc('account-123').get();
if (account.amount < 10) {
console.log('事务执行失败，下单失败');
await transaction.rollback();
return {
success: false,
message: '账户余额不足',
};
}
const order = await orderCollection.add({
data: {
orderName: 'order-123',
status: 'CREATED',
},
});
const amountLeft = account.amount - 10;
await accountCollection.doc('account-123').update({
data: {
amount: amountLeft,
}
});
await transaction.commit();
console.log('事务执行成功，下单成功');
return {
success: true,
orderId: order._id,
amountLeft,
};
```

--------------------------------

### Implement Camera Frame Listener

Source: https://opendocs.alipay.com/mini/03qfja

Example showing the AXML structure for the camera component and the corresponding JS logic to initialize the camera context and start frame listening.

```axml
<camera
  id="camera"
  flash="off"
  frame-size="medium"
  device-position="back"
  onReady="onCameraReady"
  style="width: 100%; height: 300px"
/>
```

```javascript
Page ({
  onCameraReady (e) {
    console.log ('相机初始化完成');
    this.cameraContext = my.createCameraContext ('camera');

    const listener = this.cameraContext.onCameraFrame (frame => {
      console.log (frame, frame.data.byteLength);
    });

    // 开始监听帧数据
    listener.start ({
      success: res => {
        console.log (res);
      },
      fail: err => {
        console.log (err);
      },
    });
  },
});
```

```json
{
  "success": true
}
```

--------------------------------

### my.getLaunchOptionsSync()

Source: https://opendocs.alipay.com/mini/037zgy

Retrieves the parameters passed when the mini program was cold-started. For hot start scenarios, use my.getEnterOptionsSync.

```APIDOC
## my.getLaunchOptionsSync()

### Description
Gets the parameters for the mini program's cold start. For hot start scenarios, use `my.getEnterOptionsSync` to get the latest entry parameters.

### Method
`my.getLaunchOptionsSync()`

### Parameters
This method does not take any parameters.

### Return Value
**options** (Object) - An object containing the launch parameters.

- **query** (Object) - The query parameters passed when launching the mini program. This property is omitted if there are no launch parameters.
- **scene** (String) - The scene value for launching the mini program.
- **path** (String) - The current mini program's page path, parsed from the `page` field of the launch parameters. Defaults to the homepage if `page` is ignored.
- **referrerInfo** (Object) - Information about the referrer.
  - **appId** (String) - The appId of the referring mini program.
  - **extraData** (Object) - Data passed from the referring mini program.
- **apiCategory** (string) - The API category. Enum values include 'default' and 'embedded' (when opened in a half-screen mode).

### Code Example
```javascript
const options = my.getLaunchOptionsSync();
console.log(options);
```

### Response Example
```json
{
    "apiCategory": "default",
    "path": "pages/index/index",
    "referrerInfo": {},
    "query": {
        "key": "222"
    },
    "scene": "1011"
}
```

### Related Documentation
- [小程序运行机制](link-to-runtime-mechanism)
- [如何获取各种场景的启动参数](link-to-scene-parameters)
- [小程序场景值](link-to-scene-values)
- [调试跳转未上线小程序版本](link-to-debug-unreleased)
- [IDE配置/获取全局参数和页面参数（启动参数）](link-to-ide-params)
- [小程序scheme链接介绍](link-to-scheme-intro)
```

--------------------------------

### Get Recorder Manager Instance

Source: https://opendocs.alipay.com/mini/api/getrecordermanager

Initializes the recorder manager to start recording operations.

```javascript
const recorderManager = my.getRecorderManager();
```

--------------------------------

### Gyroscope Listener Implementation

Source: https://opendocs.alipay.com/mini/038q8x

A complete example demonstrating how to start, stop, and manage multiple gyroscope listeners in an Alipay mini-program.

```axml
<view>
  <button size="default" type="primary" onTap="start">开始监听</button>
  <button size="default" style="margin-top: 30rpx;" type="primary" onTap="stop">停止监听</button>
  <button size="default" style="margin-top: 30rpx;" type="primary" onTap="offSingle">移除单个</button>
  <button size="default" style="margin-top: 30rpx;" type="primary" onTap="offAll">移除全部</button>
</view>
```

```js
Page({
    listener(res) {
        console.log("1" + JSON.stringify(res))
    },
    listener2(res) {
        console.log("2" + JSON.stringify(res));
    },
    start() {
        my.startGyroscope({
            success: () => {
                my.onGyroscopeChange(this.listener);
                my.onGyroscopeChange(this.listener2);
            }
        });
    },
    stop() {
        my.stopGyroscope();
    },
    offSingle() {
        my.offGyroscopeChange(this.listener);
    },
    offAll() {
        my.offGyroscopeChange();  
    }
});
```

```json
{
    "timestamp": 845539236097,
    "x": -0.048944138,
    "y": -0.02519745,
    "z": 0.036498122
}
```

--------------------------------

### 执行 preview 真机预览指令

Source: https://opendocs.alipay.com/mini/02q2a2

通过 CLI 命令行工具启动真机预览功能。

```bash
mini-program-cli preview
```

--------------------------------

### Synchronous File Writing Example

Source: https://opendocs.alipay.com/mini/api/024whd

Demonstrates how to initialize the file system manager and write data to a file synchronously.

```javascript
const fs = my.getFileSystemManager();

const result = fs.writeFileSync(
  `${my.env.USER_DATA_PATH}/test.txt`,
  'some text or arrayBuffer',
  'utf8'
);
console.log(result);
```

```json
{
    "error": 10024,
    "errorMessage": "指定的路径没有写权限 source/test.txt"
}
```

--------------------------------

### Get Network Type Implementation

Source: https://opendocs.alipay.com/mini/006lh7

A complete example demonstrating how to trigger a network status check and display the result in an Alipay mini program.

```axml
<view class="page">
  <view class="page-section">
      <view class="page-section-demo">
          <view class="page-body-title">网络状态</view>
          <block a:if="{{hasNetworkType === false}}">
              <text class="page-body-text">未获取</text>
              <text class="page-body-text">点击按钮可获取网络状态</text>
          </block>
          <block a:if="{{hasNetworkType === true}}">
              <text class="page-body-text-network-type">{{ networkType }}</text>
          </block>
      </view>
      <view class="page-section-btns">
          <view onTap="getNetworkType">获取手机网络状态</view>
          <view onTap="clear">清空</view>
      </view>
  </view>
</view>
```

```javascript
Page({
    data: {
        hasNetworkType: false,
        networkType:''
    },
    getNetworkType() {
        my.getNetworkType({
            success: (res) => {
                this.setData({
                    hasNetworkType: true,
                    networkType: res.networkType
                })
            },
            fail: (error) => {
                console.log(error)
            },
        })
    },
    clear() {
        this.setData({
            hasNetworkType: false,
            networkType: ''
        })
    },
});
```

--------------------------------

### Implement Screen Brightness Controls

Source: https://opendocs.alipay.com/mini/038x6j

A complete example demonstrating how to get, set, and manage screen brightness and keep-on status in an Alipay Mini Program.

```javascript
Page({
    data: {
        status: false,
        brightness: 1,
    },
    onLoad() {
        my.getScreenBrightness({
            success: res => {
                this.setData({
                    brightness: res.brightness
                })
            },
            fail: (error) => {
                console.log(error)
            }
        })
    },
    sliderChange(e) {
        my.setScreenBrightness({
            brightness: e.detail.value,
            success: (res) => {
                this.setData({
                    brightness: e.detail.value,
                })
            },
            fail: (error) => {
                console.log(error)
            }
        })
    },
    switchKeepScreenOn(e) {
        my.setKeepScreenOn({
            keepScreenOn: e.detail.value,
            success: (res) => {
                this.setData({
                    status: e.detail.value,
                })
            },
            fail: (error) => {
                console.log(error)
            }
        })
    },
    getBrightness() {
        my.getScreenBrightness({
            success: res => {
                my.alert({
                    content: `当前屏幕亮度：${res.brightness}`
                });
            },
            fail: (error) => {
                console.log(error)
            }
        })
    }
});
```

```axml
<view class="page">
  <view class="page-description">屏幕亮度 API</view>
  <view class="page-section">
    <view class="page-section-title">设置是否保持屏幕长亮状态</view>
    <view class="page-section-demo">
      <switch checked="{{status}}" onChange="switchKeepScreenOn" />
    </view
  </view>
  <view class="page-section">
    <view class="page-section-title">设置屏幕亮度</view>
    <view class="page-section-demo">
      <slider value="{{brightness}}" max="1" min="0" onChange="sliderChange" step="0.02" />
    </view>
  </view>
  <view class="page-section">
    <view class="page-section-title">获取屏幕亮度</view>
    <view class="page-section-demo">
      <button type="primary" onTap="getBrightness">获取屏幕亮度</button>
    </view>
  </view>
</view>
```

```acss
.page {
  font-family: -apple-system-font,Helvetica Neue,Helvetica,sans-serif;
  font-size: 24rpx;
  padding: 32rpx;
  flex: 1;
  background: #f7f7f7;
}

.page-description {
  margin-bottom: 32rpx;
}

.page-section {
  background: #fff;
  margin-bottom: 32rpx;
}

.page-section-title {
  padding: 16rpx 32rpx;
}

.page-section-demo {
  padding: 32rpx;
}
```

```json
{
    "brightness":0.5
}
```

--------------------------------

### Get BLE Device Characteristics Implementation

Source: https://opendocs.alipay.com/mini/03947y

A complete example showing the AXML button trigger and the corresponding JavaScript logic to connect to a device and retrieve its characteristics.

```axml
<view>
  <button onTap="getBLEDeviceCharacteristics">获取设备特征列表-getBLEDeviceCharacteristics</button>
</view>
```

```javascript
Page({
    data: {
      // 本示例值为假数据，实际开发中可使用 my.startBluetoothDevicesDiscovery API 和 my.onBluetoothDeviceFound API 去获取 deviceId。
      deviceId: "55829650-FB8A-4C86-1F80-D8DEC4DFDC5D",
      // 本示例值为假数据，实际开发中可使用 my.getBLEDeviceServices API 去获取 serviceId。
      serviceId: "44:90:BB:99:41:A5",
      characteristicId: "",
    },
    // 连接设备
    connectBLEDevice() {
      my.connectBLEDevice({
        deviceId: this.data.deviceId,
        success: () => {
          my.alert({ content: "连接成功" });
        },
        fail: (error) => {
          console.error('连接失败: ', JSON.stringify(error));
        }
      });
    },
    // 获取低功耗蓝牙设备指定服务的特征列表
    getBLEDeviceCharacteristics() {
      my.getBLEDeviceCharacteristics({
        deviceId: this.data.deviceId,
        serviceId: this.data.serviceId,
        success: (res) => {
          console.log(res)
          // 可根据业务需要，去选择实际业务中需要的 characteristicId 值。
          this.setData({
            characteristicId: res.characteristics[0].characteristicId,
          });
        },
        fail: (error) => {
          console.error('获取信息失败: ', JSON.stringify(error));
        }
      });
    },
  });
```

--------------------------------

### CLI Command: web

Source: https://opendocs.alipay.com/mini/02q17s

Launches the Web Simulator locally after the DevServer has been started.

```APIDOC
## CLI Command: web

### Description
Starts the Web Simulator locally for debugging purposes after the `minidev dev` server is running.

### Parameters
#### Options
- **--auto-open** (Boolean) - Optional - Automatically open the simulator, default is true.
- **-a, --app-id** (String) - Optional - The mini-program application ID.
- **--page** (String) - Optional - The entry page path for the simulator.
- **--page-query** (String) - Optional - Page parameters, accessible in the current page's onLoad method (e.g., name=vendor&color=black).
- **--query** (String) - Optional - Global parameters, accessible in app.js onLaunch (e.g., name=vendor&color=black).
- **--scene** (String) - Optional - The entry scene value (channelId).
```

--------------------------------

### StartNavigation

Source: https://opendocs.alipay.com/mini/02bp9p

该接口用于根据目的地信息触发硬件设备的导航功能。

```APIDOC
## StartNavigation

### Description
根据目的地信息进行导航，将导航信息传递给硬件设备。

### Parameters
#### Request Body
- **latitude** (double) - Required - 纬度
- **longitude** (double) - Required - 经度
- **address** (String) - Required - 目的地地址
- **name** (String) - Required - 地点名称

### Request Example
{
  "address": "目标地址",
  "name": "名称",
  "latitude": 30.256924,
  "longitude": 120.085044
}
```

--------------------------------

### Open Date Picker

Source: https://opendocs.alipay.com/mini/006l44

Example demonstrating how to configure the date picker with a specific format, initial date, and date range constraints.

```javascript
my.datePicker({
  format: "yyyy-MM-dd HH:mm",
  currentDate: "2023-05-28 12:12",
  startDate: "2020-01-01 11:11",
  endDate: "2023-12-31 13:13",
  success: (res) => {
    console.log(res);
  },
  fail: (err) => {
    console.log(err);
  },
});
```

--------------------------------

### Get BLE MTU Implementation

Source: https://opendocs.alipay.com/mini/039309

Example showing the AXML button trigger, the JavaScript logic to connect to a device and retrieve the MTU, and the expected success response format.

```axml
<view>
  <button onTap="getBLEMTU">获取设备最大传输单元</button>
</view>
```

```javascript
Page({
  data: {
    deviceId: "00:0F:0F:11:22:33",
  },
  // 连接设备成功后获取设备的最大传输单元
  getBLEMTU() {
    my.connectBLEDevice({
      deviceId: this.data.deviceId,
      success: () => {
        my.alert({ content: "连接成功" });
        my.getBLEMTU({
          deviceId: this.data.deviceId,
          success: (res) => {
            console.log(res, "调用成功的回调");
          },
          fail: (error) => {
            console.log(error, "调用失败的回调");
          },
        });
      },
      fail: (error) => {
        console.error('连接失败: ', JSON.stringify(error));
      },
    });
  },
});
```

```json
{
    "mtu":"512"
}
```

--------------------------------

### 调用 setUpdatePerformanceListener 获取性能统计

Source: https://opendocs.alipay.com/mini/069xfk

在组件的 onInit 生命周期中调用 setUpdatePerformanceListener，并设置 withDataPaths 为 true 以获取变更的 data 字段信息。

```javascript
Component({
onInit() {
this.setUpdatePerformanceListener({withDataPaths: true}, (res) => {
console.log(res)
})
}
})
```

--------------------------------

### Environment Object Response Example

Source: https://opendocs.alipay.com/mini/037zgu

Example structure of the object returned by my.env.

```json
{
  "USER_DATA_PATH": "https://usr",
  "clientName": "ap",
  "clientVersion": "10.3.80",
  "language": "zh-Hans",
  "platform": "iOS"
}
```

--------------------------------

### my.startWifi

Source: https://opendocs.alipay.com/mini/039dje

Initializes the Wi-Fi module in the Alipay Mini Program environment.

```APIDOC
## my.startWifi

### Description
Initializes the Wi-Fi module. This must be called before other Wi-Fi related APIs.

### Method
JavaScript SDK Method

### Endpoint
my.startWifi(Object object)
```

--------------------------------

### my.showAuthGuide(Object object)

Source: https://opendocs.alipay.com/mini/006lk2

Displays a prompt dialog to guide the user to grant specific system permissions. It is recommended to check permissions via my.getSystemInfo or handle failures from other APIs before calling this method.

```APIDOC
## my.showAuthGuide(Object object)

### Description
Displays a prompt dialog to guide the user to grant specific system permissions required by the mini program.

### Parameters
#### Object object
- **authType** (String) - Required - The type of permission to guide the user to grant. Supported values: BLUETOOTH, SHORTCUT, NOTIFICATION, MICROPHONE, ADDRESSBOOK, CAMERA, PHOTO, LBS, LBSHIGHACCURACY.
- **success** (Function) - Optional - Callback function executed on success. Returns an object with a 'shown' (Boolean) property indicating if the dialog was displayed.
- **fail** (Function) - Optional - Callback function executed on failure. Returns an object with 'error' and 'errorMessage'.
- **complete** (Function) - Optional - Callback function executed when the call finishes.

### Request Example
{
  "authType": "LBS"
}

### Error Handling
- **2**: Parameter error. Ensure the provided authType is valid.
```

--------------------------------

### Error Response Example

Source: https://opendocs.alipay.com/mini/006leg

Example of an error object returned when a file type is not supported.

```json
{
  "error": 4013,
  "errorMessage": "暂不支持此文件类型。"
}
```

--------------------------------

### Verify CPT CLI installation

Source: https://opendocs.alipay.com/mini/089cbp

Execute the cpt command to confirm the installation was successful.

```bash
cpt
```

--------------------------------

### Listen for Recording Start Event

Source: https://opendocs.alipay.com/mini/039bok

Registers a callback function to be executed when the recording starts.

```javascript
let recorderManager = my.getRecorderManager ();
recorderManager.onStart (() => {
  console.log ('监听录音开始事件');
});
```

--------------------------------

### Offline Search Direct Configuration in Java

Source: https://opendocs.alipay.com/mini/03hvky

Example demonstrating how to use the Alipay SDK to call the offline search direct interface.

```java
package com.java.sdk.demo;

import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.domain.AlipayOpenSearchBoxOfflineModel;
import com.alipay.api.request.AlipayOpenSearchBoxOfflineRequest;
import com.alipay.api.response.AlipayOpenSearchBoxOfflineResponse;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;

public class AlipayOpenSearchBoxOffline {

    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        AlipayOpenSearchBoxOfflineRequest request = new AlipayOpenSearchBoxOfflineRequest();
        AlipayOpenSearchBoxOfflineModel model = new AlipayOpenSearchBoxOfflineModel();
        model.setBoxId("20211130000000100415");
        model.setMerchantId("2088xxxxxxxxxxxx");
        request.setBizModel(model);
        AlipayOpenSearchBoxOfflineResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
```

--------------------------------

### Query Items API Request Example

Source: https://opendocs.alipay.com/mini/4fd6b065_alipay.open.mini.cloud.aositem.query

Example request for the alipay.open.mini.cloud.aositem.query method using cURL.

```cURL
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.open.mini.cloud.aositem.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'biz_content={
	"cate":[
		"家电$##$电视$##$OLED电视"
	],
	"aggregation_field":"shipping,color",
	"client_env":"ios",
	"device_id":"01010Jq02O5XceJUHST0Q2nWlRFY",
	"open_id":"072PZjio8MFya3OHw9tl41J7Ypk01Z5wBJXC6vlkz0kbjYd",
	"ext_rep_filed":"price,tags",
	"query":"iPhone",
	"latitude":"30.355",
	"page_num":1,
	"city_code":"330100",
	"filters":[
		"brand:iphone OR huawei",
		"color:black OR white"
	],
	"tags":[
		"特惠",
		"热卖"
	],
	"user_id":"2088702293687723",
	"project_id":"10000410",
	"user_id_type":"ALIPAY",
	"orders":[
		"+createTime",
		"-price"
	],
	"item_id_list":[
		"234434",
		"356666"
	],
	"page_size":"10",
	"longitude":"120.24"
}'
```

--------------------------------

### Write File Example

Source: https://opendocs.alipay.com/mini/api/022b6s

Demonstrates how to use the writeFile method to save text data to a local user file path.

```javascript
let fs = my.getFileSystemManager();
fs.writeFile({
  filePath: `${my.env.USER_DATA_PATH}/test.txt`,
  data: 'some text or arrayBuffer',
  success(res) {
    console.log(res);
  },
  fail(err) {
    console.log(err);
  }
});
```

```json
{
    "success": true
}
```

```json
{
    "error": 10024,
    "errorMessage": "指定的路径没有写权限 source/test.txt"
}
```

--------------------------------

### 配置项操作指令

Source: https://opendocs.alipay.com/mini/02q3aq

使用 minidev config 指令进行配置项的读取与设置。

```bash
minidev config set/get key [value]
```

--------------------------------

### Projection Usage Examples

Source: https://opendocs.alipay.com/mini/089cb9

Examples demonstrating how to filter fields in cloud functions and mini-program environments.

```javascript
db.collection('todos').field({
  name: true,
  description: true,
  secret: false
}).get()
```

```javascript
db.collection('todos').field({
  name: true,
  description: true,
  secret: false
}).get()
```

--------------------------------

### Gray-scale release request example

Source: https://opendocs.alipay.com/mini/03l3ev

Example of how to call the gray-scale release API using cURL.

```cURL
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.open.mini.version.gray.online&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}' \
 -F 'biz_content={
	"app_version":"0.0.1",
	"bundle_id":"com.alipay.alipaywallet",
	"gray_strategy":"p10"
}'
```

--------------------------------

### my.getSetting

Source: https://opendocs.alipay.com/mini/038x6n

Retrieves the current settings of the mini program, including authorization status for various features.

```APIDOC
## my.getSetting

### Description
Retrieves the current settings of the mini program. This method returns the authorization status for features that require user permission.

### Method
JavaScript SDK Method

### Parameters
- **success** (Function) - Optional - Callback function called when the request succeeds.
- **fail** (Function) - Optional - Callback function called when the request fails.
- **complete** (Function) - Optional - Callback function called when the request completes (success or fail).

### Response
- **authSetting** (Object) - An object containing the authorization status for each feature.
```

--------------------------------

### Error Response Example

Source: https://opendocs.alipay.com/mini/api/as9kin

Example of the error object returned in the fail callback when required parameters are missing.

```json
{
    "error": 2,
    "errorMessage": "缺少必要参数(经纬度，位置名称和位置描述)"
}
```

--------------------------------

### 目标小程序获取应用参数

Source: https://opendocs.alipay.com/mini/006lma

在 App 的 onLaunch 生命周期或通过 getLaunchOptionsSync 获取跳转传递的 query 和 extraData。

```javascript
App({
    onLaunch(options) {
      const { query, referrerInfo: { extraData } = {} } = options;
      console.log('query:', query); // query: { a: 'foo', b: 'bar' }
      console.log('extraData:', extraData); // extraData: { x: { y: 'z' } }
    },
    onSomeButtonTap() {
      const { query, referrerInfo: { extraData } = {} } = my.getLaunchOptionsSync();
      console.log('query:', query); // query: { a: 'foo', b: 'bar' }
      console.log('extraData:', extraData); // extraData: { x: { y: 'z' } }
    },
  });
```

--------------------------------

### Open Settings Interface

Source: https://opendocs.alipay.com/mini/038q9c

Opens the mini program settings page and logs the authorization results in the success callback.

```javascript
my.openSetting({
  withSubscriptions: true,
  success: function(res) {
    console.log(res);
  },
  fail: function(err) {
    console.log(err);
  }
});
```

--------------------------------

### Error response example

Source: https://opendocs.alipay.com/mini/api/0226of

Example of the error object returned in the fail callback when a file operation fails.

```json
{
    "error": 10022,
    "errorMessage": "指定的 srcPath 文件不存在 https://usr/a/a.txt"
}
```

--------------------------------

### my.startBluetoothDevicesDiscovery

Source: https://opendocs.alipay.com/mini/038q9e

开始搜寻附近的蓝牙外围设备。

```APIDOC
## my.startBluetoothDevicesDiscovery

### Description
开始搜寻附近的蓝牙外围设备。此操作比较耗费系统资源，请在搜索到目标设备后及时调用 my.stopBluetoothDevicesDiscovery 停止搜索。

### Parameters
- **services** (Array) - Optional - 要搜索的蓝牙设备主 service 的 uuid 列表
- **success** (Function) - Optional - 接口调用成功的回调函数
- **fail** (Function) - Optional - 接口调用失败的回调函数
```
Tokens:
Raw