---
name: "postBLEBigDataChannelWithProgress"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "3.0.0" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## postBLEBigDataChannelWithProgress

> [VERSION] DeviceKit >= 3.0.0 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Big-data channel operations with progress feedback. Different feedback is returned to the frontend via these events: 1. Device-to-app big-data transfer success: 【onBLEBigDataChannelDeviceToAppSuccess】; 2. Cloud upload progress: 【onBLEBigDataChannelUploadCloudProgress】; 3. BLE data channel transfer progress: 【onBLEBigDataChannelProgressEvent】

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | `3.0.0` | deviceId Device ID |
| `requestParams` | `Record<string, Record<string, any>>` | Yes | - | `3.0.0` | Parameters required to establish data transfer command: Specific channel operation command; start/stop: open/close the big-data channel; type: data type to upload requestParams Channel command set {   "command": "start",   "type": "1" } |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `deviceId` | `string` | `3.3.0` | deviceId Device ID |
| `resultParams` | `Record<string, Record<string, any>>` | `3.3.0` | Parameters upon completion of data transfer (type dps fileUrl) resultParams Parameters upon completion of data transfer |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Basic usage

```tsx
import { device } from '@ray-js/ray'

const { postBLEBigDataChannelWithProgress } = device;

postBLEBigDataChannelWithProgress({
  deviceId: 'device_001',
  requestParams: {},
  success: (result) => {
    console.log('postBLEBigDataChannelWithProgress success', result);
  },
  fail: (error) => {
    console.log('postBLEBigDataChannelWithProgress fail', error.errorMsg);
  },
});
```