@ doordeck/ headless-resact-inative-sdk (英语)
概览
这个 @doordeck/headless-react-native-sdk 是一种轻量级的再现原生SDK 在Doordeck SDK上方建造. 这个SDK为认证和锁管理提供了最低限度的接口,专注于用户的造型操作. 它使得React Independent应用程序能够通过Doordeck的平台认证用户,管理认证符,检索锁细节并解锁设备.
安装
要安装 SDK, 请确保您在您的工程中设置了 React Industrial, 然后添加必要的依赖性 :
npm install @doordeck/headless-react-native-sdk
或使用线条 :
yarn add @doordeck/headless-react-native-sdk
iOS系统
在安装软件包后, 安装 sockers :
cd ios && pod install
本地的Doordeck SDK作为CocoaPods的依赖物自动拉入(DoordeckSDK, 动态 xcframework) 并被CocoaPods嵌入到您的应用程序中——不需要额外的Podfile配置或构建相. SDK 与默认的静态- 图书馆链接以及同 use_frameworks! (两者) :static 财务报告和审定财务报表 :dynamic) (中文(简体) ).
使用量
导入 SDK
根据您的用法导入每种方法
import { login } from '@doordeck/headless-react-native-sdk';
// ...
import { logout } from '@doordeck/headless-react-native-sdk';
认证方法
login(email: string, password: string): Promise<AssistedRegisterEphemeralKeyResponse>
登录用户的电子邮件和密码.
说明: 如果在同一会话中未进行校验而进行登录,认证只会持续到运行时间内存,并在应用程序重启时丢失.
import { login } from '@doordeck/headless-react-native-sdk';
login("[email protected]", "password123")
.then(response => console.log("Login successful", response))
.catch(error => console.error("Login failed", error));
setAuthToken(authToken: string): Promise<AssistedRegisterEphemeralKeyResponse>
手动设置认证符号.
说明: 和登录一样,未经验证的认证只会在运行时内存中持续存在,并在应用程序重启后丢失.
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和认证上下文被保存在持续存储中.
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.
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>
获取与特定瓦片相关的锁列表.
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的设备.
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 开发者文档。 。 。 .