---
name: "getCleaningRecords"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.36" }
  - { name: "基础库", version: "2.21.0" }
title: "清扫记录"
---

## getCleaningRecords

> [VERSION] @ray-js/ray >= 1.5.36 | 基础库 >= 2.21.0

### 描述

获取清扫记录列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `GetCleaningRecordsParams` | 是 | 查询参数，包含设备 ID、时间范围和分页信息 |

### 返回值

类型: `Promise<GetCleaningRecordsResponse>`

Promise，resolve 值为清扫记录列表和总数

##### GetCleaningRecordsResponse

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `datas` | `CleaningRecord[]` | 清扫记录列表 |
| `totalCount` | `number` | 记录总数 |

### 引用对象

##### `interface` GetCleaningRecordsParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `startTime` | `string` | 开始时间（时间戳字符串） |
| `endTime` | `string` | 结束时间（时间戳字符串） |
| `limit` | `number` | 返回的数据长度限制 |
| `offset` | `number` | 分页偏移量 |
| `fileType` | `string` | 文件类型，默认 'pic' |

##### `interface` CleaningRecord

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `number` | 清扫记录唯一 ID |
| `time` | `number` | 清扫时间戳 |
| `file` | `string` | 清扫记录文件路径 |
| `bucket` | `string` | 文件所在存储桶 |
| `extend` | `string` | 清扫信息（扩展字段） |
| `devId` | `string` | 设备 ID |
| `fileType` | `string` | 文件类型 |


### 示例代码

```tsx
import React from 'react';
import { Button, getCleaningRecords } from '@ray-js/ray';

export default function Demo() {
  const handleFetch = async () => {
    const result = await getCleaningRecords({
      devId: 'your-device-id',
      startTime: '1700000000',
      endTime: '1700086400',
      offset: 0,
      limit: 10,
    });
    console.log(result.datas, result.totalCount);
  };
  return <Button onClick={handleFetch}>获取清扫记录</Button>;
}
```


---
name: "deleteCleaningRecord"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.36" }
  - { name: "基础库", version: "2.21.0" }
title: "清扫记录"
---
## deleteCleaningRecord

> [VERSION] @ray-js/ray >= 1.5.36 | 基础库 >= 2.21.0

### 描述

删除清扫记录

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `DeleteCleaningRecordParams` | 是 | 包含设备 ID 和要删除的记录 ID 数组 |

### 返回值

类型: `Promise<boolean>`

Promise，resolve 值为 boolean，表示删除是否成功

### 引用对象

##### `interface` DeleteCleaningRecordParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `fileIds` | `number[]` | 要删除的记录 ID 数组 |


### 示例代码

```tsx
import React from 'react';
import { Button, deleteCleaningRecord } from '@ray-js/ray';

export default function Demo() {
  const handleDelete = async () => {
    const success = await deleteCleaningRecord({
      devId: 'your-device-id',
      fileIds: [1001, 1002],
    });
    console.log('删除结果:', success);
  };
  return <Button onClick={handleDelete}>删除记录</Button>;
}
```


---
name: "getGyroCleanRecords"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.7.14" }
  - { name: "基础库", version: "2.29.0" }
title: "清扫记录"
---
## getGyroCleanRecords

> [VERSION] @ray-js/ray >= 1.7.14 | 基础库 >= 2.29.0

### 描述

获取陀螺仪扫地机的清扫记录列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `GetGyroCleanRecordsParams` | 是 | 查询参数，包含设备 ID、DP 点集合和分页信息 |

### 返回值

类型: `Promise<GetGyroCleanRecordsResponse>`

Promise，resolve 值为陀螺仪清扫记录列表和总数

##### GetGyroCleanRecordsResponse

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `datas` | `GyroCleanRecord[]` | 清扫记录列表 |
| `totalCount` | `number` | 记录总数 |

### 引用对象

##### `interface` GetGyroCleanRecordsParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `dpIds` | `number[]` | DP 点 ID 集合 |
| `offset` | `number` | 分页偏移量 |
| `limit` | `number` | 每页数量 |
| `userId` | `string` | 用户 ID，默认传 '0' |

##### `interface` GyroCleanRecord

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `dpId` | `number` | DP 点 ID |
| `gid` | `number` | 地图 ID |
| `gmtCreate` | `number` | 记录创建时间戳 |
| `recordId` | `string` | 记录 ID |
| `uuid` | `string` | 设备 UUID |
| `value` | `string` | 记录值 |


### 示例代码

```tsx
import React from 'react';
import { Button, getGyroCleanRecords } from '@ray-js/ray';

export default function Demo() {
  const handleFetch = async () => {
    const result = await getGyroCleanRecords({
      devId: 'your-device-id',
      dpIds: [101, 102],
      offset: 0,
      limit: 10,
    });
    console.log(result.datas, result.totalCount);
  };
  return <Button onClick={handleFetch}>获取陀螺仪记录</Button>;
}
```


---
name: "getGyroCleanRecordDetail"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.7.14" }
  - { name: "基础库", version: "2.29.0" }
title: "清扫记录"
---
## getGyroCleanRecordDetail

> [VERSION] @ray-js/ray >= 1.7.14 | 基础库 >= 2.29.0

### 描述

获取陀螺仪扫地机的清扫记录详情

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `GetGyroCleanRecordDetailParams` | 是 | 查询参数，包含设备 ID、子记录 ID 和分页信息 |

### 返回值

类型: `Promise<GetGyroCleanRecordDetailResponse>`

Promise，resolve 值为清扫记录的地图数据和分页信息

##### GetGyroCleanRecordDetailResponse

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `dataList` | `string[]` | 地图数据列表 |
| `startRow` | `string` | 起始行标识 |
| `devId` | `string` | 设备 ID |
| `mapId` | `number` | 地图 ID |
| `startTime` | `number` | 清扫开始时间戳 |
| `endTime` | `number` | 清扫结束时间戳 |
| `subRecordId` | `number` | 子记录 ID |
| `hasNext` | `boolean` | 是否有下一页 |

### 引用对象

##### `interface` GetGyroCleanRecordDetailParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `subRecordId` | `number` | 子记录 ID |
| `start` | `number` | 起始行（startRow） |
| `size` | `number` | 每次获取的数据量 |


### 示例代码

```tsx
import React from 'react';
import { Button, getGyroCleanRecordDetail } from '@ray-js/ray';

export default function Demo() {
  const handleFetch = async () => {
    const detail = await getGyroCleanRecordDetail({
      devId: 'your-device-id',
      subRecordId: 12345,
      start: 0,
      size: 100,
    });
    console.log(detail.dataList, detail.hasNext);
  };
  return <Button onClick={handleFetch}>获取记录详情</Button>;
}
```