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

## getTempEffectiveList

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

### 描述

获取有效临时密码列表。

### 参数

无


### 返回值

类型: `Promise<EffectivePasswrodItem[]>`

当前有效临时密码列表

##### EffectivePasswrodItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `status` | `ValidPasswordStatus` | 密码状态 |
| `unlockBindingId` | `string` | 密码 ID |
| `effectiveConfig` | `EffectiveConfig` | 生效配置 |
| `name` | `string` | 密码名称 |
| `type` | `TemporaryPasswordType` | 密码类型 |
| `sn` | `number` | 密码 sn |
| `hasClearPwd` | `boolean` | 当前密码是否被标记为将被清除 |
| `clearInfo` | `Object` | 清除单个密码时的目标信息 |

##### EffectivePasswrodItem.clearInfo 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `name` | `string` | 是 | - | 单个密码名称 |
| `effectiveConfig` | `EffectiveConfig` | 是 | - | 单个密码生效配置 |


### 引用对象

##### `type` ValidPasswordStatus

临时密码「生效中」状态枚举

- effective: 生效
- toBeEffective: 待生效
- frozen: 冻结
- freezing: 冻结中
- synchronizing: 同步中
- toBeDeleted: 待删除

```typescript
export type ValidPasswordStatus =
  | "effective"
  | "toBeEffective"
  | "frozen"
  | "freezing"
  | "synchronizing"
  | "toBeDeleted";
```

##### `interface` EffectiveConfig

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

##### `type` TemporaryPasswordType

临时密码业务子类型

```typescript
export type TemporaryPasswordType =
  | "custom"
  | "once"
  | "limit"
  | "clear"
  | "clearOne";
```

##### `type` Week

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

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

##### `type` BitStatus

位开关：0 关、1 开 / Single-bit flag

```typescript
export type BitStatus = 0 | 1;
```


### 示例代码

#### 示例

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