---
name: "getTempOfflineInvalidList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getTempOfflineInvalidList - 获取离线失效密码列表，适用于 WiFi 拍照锁设备。"
summary: "获取离线失效密码列表，适用于 WiFi 拍照锁设备。根据密码类型返回对应的失效密码列表。"
---

## getTempOfflineInvalidList

> [VERSION] @ray-js/lock-sdk >= 1.0.0

> 💡 此 API 为 WiFi Pro 锁专用，其他锁请勿使用。

### 描述

获取离线失效密码列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `pwdTypeCode` | `"once" \| "multiple" \| "clear_one" \| "clear_all"` | 是 | 离线密码类型 |

### 返回值

类型: `Promise<EffectivePasswrodItem[]>`

列表

##### EffectivePasswrodItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `effective` | `number` | 是否有效：1 有效、0 无效 |
| `unlockBindingId` | `string` | 云端开锁方式记录 id |
| `effectiveTime` | `number` | 生效时间（秒级时间戳） |
| `failReason` | `number` | 失效原因码；0 表示无失效原因 |
| `invalidTime` | `number` | 失效时间（秒级时间戳） |
| `name` | `string` | 密码名称 |
| `phase` | `number` | 状态：1 正常、2 待确认、3 冻结、10 待添加 |
| `scheduleDetails` | `Object[]` | 生效周期详情；按周重复时每项描述一个时间段 |
| `opModeType` | `number` | 开锁方式类型 |
| `opModeSubType` | `number` | 开锁方式子类型；临时密码场景下承载可用次数等语义 |
| `sn` | `number` | 密码在门锁端的编号 |
| `opModeInfo` | `Object` | 清空码附加信息（仅清空码类型下发） |
| `availTime` | `number` | 可用次数；不下发表示不限次 |
| `timeSetType` | `number` | 时效类型：0 单次、10 永久、20 起止、30 循环 |
| `shareInfo` | `Object` | 分享信息（虚拟钥匙/分享类记录下发） |

##### EffectivePasswrodItem.scheduleDetails[] 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `allDay` | `boolean` | 是 | - | 是否全天有效 |
| `effectiveTime` | `number` | 是 | - | 每日生效时间（当天 0 点起的分钟数） |
| `invalidTime` | `number` | 是 | - | 每日失效时间（当天 0 点起的分钟数） |
| `timeZoneId` | `string` | 是 | - | 时区 id |
| `workingDay` | `number` | 是 | - | 生效星期位图 |


##### EffectivePasswrodItem.opModeInfo 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `hasClearPwd` | `boolean` | 否 | - | 是否已生成清空码 |
| `revokedPwdName` | `string` | 否 | - | 被撤销密码的名称 |
| `revokedPwdEffectiveTime` | `number` | 否 | - | 被撤销密码的生效时间（秒级时间戳） |
| `revokedPwdInvalidTime` | `number` | 否 | - | 被撤销密码的失效时间（秒级时间戳） |


##### EffectivePasswrodItem.shareInfo 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `account` | `string` | 是 | - | 受邀账号（手机号或邮箱） |
| `countryCode` | `string` | 是 | - | 账号国家码 |
| `lockUserId` | `number` | 是 | - | 受邀用户在锁端的用户 id |
| `offlineUnlock` | `boolean` | 是 | - | 是否允许离线解锁 |
| `phoneKeyUnlock` | `boolean` | 是 | - | 是否允许手机蓝牙钥匙解锁 |
| `userExist` | `boolean` | 否 | - | 受邀账号是否已在 App 注册；部分接口可能不下发，需结合 userName 推断 |
| `userName` | `string` | 是 | - | 受邀用户名称 |


### 示例代码

```ts
import { getTempOfflineInvalidList } from '@ray-js/lock-sdk';
const list = getTempOfflineInvalidList('once');
```