智能小程序 Ray 开发门锁 API ——用户 API 接口汇总

获取当前登录用户信息

getCurrentMemberInfo

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getCurrentMemberInfo } from '@ray-js/ray'

参数

CurrentMemberInfoParams

属性	类型	必填	说明
devId	string	是	设备 ID
dpIds	string	是	数据点 ID

返回

CurrentMemberInfoResult

属性	类型	说明
userId	number	用户 ID
lockUserId	number	锁用户 ID
userType	number	用户类型
allOpenDps	string	所有开放的数据点
allOpenType	Array<number>	所有开放类型的数组
productAttribute	number	产品属性
phase	number	阶段
expireTime	number	过期时间
expireDate	number	过期日期

函数定义示例

/**
 * 获取当前登录用户信息
 */
export function getCurrentMemberInfo(
  params: CurrentMemberInfoParams
): Promise<CurrentMemberInfoResult>

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

获取家庭成员列表（带解锁方式个数）

getFamilyMemberListWithUnlockCount

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getFamilyMemberListWithUnlockCount } from '@ray-js/ray'

参数

FamilyMemberListWithUnlockCountParams

属性	类型	必填	说明
devId	string	是	设备 ID
dpIds	Array<number>	是	数据点 ID 数组

返回

FamilyMemberListWithUnlockCountResult

Array<FamilyMemberWithUnlockDetail>，家庭成员列表数组。

函数定义示例

/**
 * 获取家庭成员列表（带解锁方式个数）
 */
export function getFamilyMemberListWithUnlockCount(
  params: FamilyMemberListWithUnlockCountParams
): Promise<FamilyMemberListWithUnlockCountResult>

家庭成员移除成功通知

removeFamilyMember

引入

@ray-js/ray^1.5.0 以上版本可使用

import { removeFamilyMember } from '@ray-js/ray'

参数

FamilyMemberRemovalParams

属性	类型	必填	说明
devId	string	是	设备 ID
userId	string	是	用户 ID

返回

FamilyMemberRemovalResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 家庭成员移除成功通知
 */
export function removeFamilyMember(
  params: FamilyMemberRemovalParams
): Promise<FamilyMemberRemovalResult>

查询是否有家庭里已删除但门锁端未删除且有设置硬件解锁方式的成员

queryUserDeletion

引入

@ray-js/ray^1.5.0 以上版本可使用

import { queryUserDeletion } from '@ray-js/ray'

参数

UserDeletionQueryParams

属性	类型	必填	说明
devId	string	是	设备 ID

返回

UserDeletionQueryResult

Array<{ userId: number, lockUserId: number }>，数组包含已删除用户的 ID 和锁用户 ID。

函数定义示例

/**
 * 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
 */
export function queryUserDeletion(params: UserDeletionQueryParams): Promise<UserDeletionQueryResult>

门锁批量同步

syncLockBatch

引入

@ray-js/ray^1.5.0 以上版本可使用

import { syncLockBatch } from '@ray-js/ray'

参数

LockSyncBatchParams

属性	类型	必填	说明
devId	string	是	设备 ID

返回

LockSyncBatchResult

属性	类型	说明
lockRandom	object	随机锁信息
lockFitting	object	锁具信息
lockRecord	string	锁记录
removedUser	Array	已移除用户信息

函数定义示例

/**
 * 门锁批量同步
 */
export function syncLockBatch(params: LockSyncBatchParams): Promise<LockSyncBatchResult>

更新用户时效

updateUserTimeSchedule

引入

@ray-js/ray^1.5.0 以上版本可使用

import { updateUserTimeSchedule } from '@ray-js/ray'

参数

UpdateUserTimeScheduleParams

属性	类型	必填	说明
devId	string	是	设备 ID
userId	string	是	用户 ID
timeScheduleInfo	TimeScheduleInfo	是	时效信息

返回

UpdateUserTimeScheduleResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 更新用户时效
 */
export function updateUserTimeSchedule(
  params: UpdateUserTimeScheduleParams
): Promise<UpdateUserTimeScheduleResult>

打开/关闭离线解锁开关

openCloseOfflineUnlock

引入

@ray-js/ray^1.5.0 以上版本可使用

import { openCloseOfflineUnlock } from '@ray-js/ray'

参数

OpenCloseOfflineUnlockParams

属性	类型	必填	说明
devId	string	是	设备 ID
userId	string	是	用户 ID
enable	boolean	是	是否启用

返回

OpenCloseOfflineUnlockResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 打开/关闭离线解锁开关
 */
export function openCloseOfflineUnlock(
  params: OpenCloseOfflineUnlockParams
): Promise<OpenCloseOfflineUnlockResult>

 👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。