---
name: "getTempInvalidList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getTempInvalidList - 获取无效的临时密码列表。"
summary: "获取无效的临时密码列表。"
---

## getTempInvalidList

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

### 描述

获取无效的临时密码列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `GetInvalidListParams` | 否 | 入参 |

### 返回值

类型: `Promise<GetTempInvalidListResult>`

已失效临时密码列表

##### GetTempInvalidListResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `list` | `InvalidPasswordItem[]` | 当前页失效密码列表 |
| `hasMore` | `boolean` | 是否还有下一页 |
| `total` | `number` | 失效密码总条数 |

### 引用对象

##### `interface` GetInvalidListParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `page` | `number` | 页码（从 1 起） |
| `pageSize` | `number` | 每页记录数，默认 200 |

##### `interface` InvalidPasswordItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `status` | `"expired"` | 状态为已失效 |
| `invalidReason` | `"synchronizationFailed" \| "passwordFull" \| "deleted"` | 失效原因 |
| `unlockBindingId` | `string` | 密码 ID |
| `effectiveConfig` | `EffectiveConfig` | 生效配置 |
| `name` | `string` | 密码名称 |
| `type` | `"custom" \| "once" \| "limit" \| "clear" \| "clearOne"` | 密码类型 |
| `sn` | `number` | 密码 sn |
| `hasClearPwd` | `boolean` | 当前密码是否被标记为将被清除 |
| `clearInfo` | `Object` | 清除单个密码时的目标信息 |

##### `interface` EffectiveConfig

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `effectiveDate` | `number` | 生效日（秒级时间戳） |
| `expiredDate` | `number` | 失效日（秒级时间戳） |
| `repeat` | `"none" \| "week"` | 重复策略：无或按周 |
| `weeks` | `Week` | 周重复位图 |
| `effectiveTime` | `number` | 每日生效开始时间，单位：分钟 |
| `expiredTime` | `number` | 每日失效结束时间，单位：分钟 |

##### `type` Week

周重复位图：下标 0–6 对应周日–周六，0 不生效 1 生效

```typescript
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];
```

##### `type` InvalidPasswordItem.clearInfo

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `name` | `string` | 单个密码名称 |
| `effectiveConfig` | `EffectiveConfig` | 单个密码生效配置 |


### 示例代码

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