# @doordeck/headless-react-native-sdk 中文文档

规范地址：https://npmcn.com/package/%40doordeck/headless-react-native-sdk/

版本：1\.0\.67
npm 元数据更新时间：2026-11-10T11:40:11.819Z
中文译文更新时间：2026-11-12T16:32:24.960Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40doordeck/headless-react-native-sdk
原文对照：https://npmcn.com/package/%40doordeck/headless-react-native-sdk/?lang=original
项目主页：https://github.com/doordeck/doordeck-headless-sdk-react-native#readme
源码仓库：https://github.com/doordeck/doordeck-headless-sdk-react-native

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：101 kB，45 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=19\.0\.0，react-native \>=0\.86\.0
- 首次发布：2025-03-11T13:15:40.007Z
- 最新版本发布：2026-11-10T11:40:11.433Z
- 近 30 天下载量：4241（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 61 个）

## 中文简介

Doordeck 反应原生无头 SDK

## 安装

```sh
npm install @doordeck/headless-react-native-sdk
```

也可以使用：`pnpm add @doordeck/headless-react-native-sdk`、`yarn add @doordeck/headless-react-native-sdk`、`bun add @doordeck/headless-react-native-sdk`

## README

# @ doordeck/ headless-resact-inative-sdk (英语)

## 概览

这个 `@doordeck/headless-react-native-sdk` 是一种轻量级的再现原生SDK 在Doordeck SDK上方建造. 这个SDK为认证和锁管理提供了最低限度的接口,专注于用户的造型操作. 它使得React Independent应用程序能够通过Doordeck的平台认证用户,管理认证符,检索锁细节并解锁设备.

## 安装

要安装 SDK, 请确保您在您的工程中设置了 React Industrial, 然后添加必要的依赖性 :

```sh
npm install @doordeck/headless-react-native-sdk
```

或使用线条 :

```sh
yarn add @doordeck/headless-react-native-sdk
```

### iOS系统

在安装软件包后, 安装 sockers :

```sh
cd ios && pod install
```

本地的Doordeck SDK作为CocoaPods的依赖物自动拉入(`DoordeckSDK`, 动态 xcframework) 并被CocoaPods嵌入到您的应用程序中——不需要额外的Podfile配置或构建相. SDK 与默认的静态- 图书馆链接以及同 `use_frameworks!` (两者) `:static` 财务报告和审定财务报表 `:dynamic`) (中文(简体) ).

## 使用量

### 导入 SDK

根据您的用法导入每种方法

```javascript
import { login } from '@doordeck/headless-react-native-sdk';
// ...
import { logout } from '@doordeck/headless-react-native-sdk';
```

### 认证方法

#### `login(email: string, password: string): Promise<AssistedRegisterEphemeralKeyResponse>`

登录用户的电子邮件和密码.

> **说明:** 如果在同一会话中未进行校验而进行登录,认证只会持续到运行时间内存,并在应用程序重启时丢失.

```javascript
import { login } from '@doordeck/headless-react-native-sdk';

login("user@example.com", "password123")
  .then(response => console.log("Login successful", response))
  .catch(error => console.error("Login failed", error));
```

#### `setAuthToken(authToken: string): Promise<AssistedRegisterEphemeralKeyResponse>`

手动设置认证符号.

> **说明:** 和登录一样,未经验证的认证只会在运行时内存中持续存在,并在应用程序重启后丢失.

```javascript
import { setAuthToken } from '@doordeck/headless-react-native-sdk';

setAuthToken("your-auth-token")
  .then(response => console.log("Token set successfully", response))
  .catch(error => console.error("Error setting token", error));
```

#### `verify(code: string): Promise<void>`

验证带有核查码的平面密钥登记。 在成功验证后,用户ID和认证上下文被保存在持续存储中.

```javascript
import { verify } from '@doordeck/headless-react-native-sdk';

verify("123456")
  .then(() => console.log("Verification successful"))
  .catch(error => console.error("Verification failed", error));
```

#### `logout(): Promise<void>`

记录当前用户并清除所存储的认证上下文,包括去除持久性用户ID.

```javascript
import { logout } from '@doordeck/headless-react-native-sdk';

logout()
  .then(() => console.log("Logged out"))
  .catch(error => console.error("Logout failed", error));
```

### 设备与平板操作

#### `getLocksBelongingToTile(tileId: string): Promise<TileLocksResponse>`

获取与特定瓦片相关的锁列表.

```javascript
import { getLocksBelongingToTile } from '@doordeck/headless-react-native-sdk';

getLocksBelongingToTile("tile-uuid")
  .then(response => console.log("Locks: ", response))
  .catch(error => console.error("Failed to get locks", error));
```

#### `unlockDevice(lockId: string): Promise<void>`

解锁一个带有锁式ID的设备.

```javascript
import { unlockDevice } from '@doordeck/headless-react-native-sdk';

unlockDevice("lock-uuid")
  .then(() => console.log("Device unlocked"))
  .catch(error => console.error("Unlock failed", error));
```

## 处理错误

每种方法返回 a `Promise`如果发生错误,则 `catch` 块将处理失败,返回包含错误代码和消息的错误对象.

## 许可证

这个SDK遵循了Doordeck许可协议. 在将这个 SDK 整合到您的项目之前, 确保遵守 Doordeck 的 API 使用政策 .

## 支助

关于补充支助,参见: [Doordeck 开发者文档](https://developer.doordeck.com/docs/#introduction)。 。 。 .

## 常见问题

### @doordeck/headless-react-native-sdk 是什么？

Doordeck 反应原生无头 SDK

### 如何安装 @doordeck/headless-react-native-sdk？

在项目目录运行 npm install @doordeck/headless-react-native-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19\.0\.0）、react-native（\>=0\.86\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @doordeck/headless-react-native-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @doordeck/headless-react-native-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @doordeck/headless-react-native-sdk 可以商用吗？

@doordeck/headless-react-native-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @doordeck/headless-react-native-sdk 的下载量有多少？

根据 npm 官方下载统计，@doordeck/headless-react-native-sdk 在 2026/10/13 – 2026/11/11 这 30 天内被下载 4,241 次，日均约 141 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @doordeck/headless-react-native-sdk 还在维护吗？

最新版本 1\.0\.67 发布于 2026/11/10（3 天前）；至今共发布 63 个版本，其中过去 12 个月发布了 61 个；首次发布于 2025/03/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。