智能小程序 Ray 开发门锁 API ——成员解锁 API 接口汇总

校验成员密码是否存在（包括临时密码）

validatePasswordForMember

引入

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

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

参数

ValidatePwdMemberParams

属性	类型	必填	说明
devId	string	是	设备 ID
opModeId	number	否	操作模式 ID
password	string	是	密码

返回

ValidatePwdMemberResult

属性	类型	说明
valid	boolean	是否有效
errorCode	string	错误代码（可选）
errorMsg	string	错误信息（可选）

函数定义示例

/**
 * 校验成员密码是否存在（包括临时密码）
 */
export function validatePasswordForMember(
  params: ValidatePwdMemberParams
): Promise<ValidatePwdMemberResult>

添加解锁方式

addMemberUnlockMethod

引入

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

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

参数

AddMemberUnlockMethodParams

属性	类型	必填	说明
devId	string	是	设备 ID
userId	string	是	用户 ID
unlockId	number	是	解锁 ID
unlockName	string	否	解锁名称
unlockAttr	number	是	解锁属性
notifyInfo	NotifyInfo	否	通知信息
unlockDetail	string	否	解锁详细信息

返回

AddMemberUnlockMethodResult

属性	类型	说明
opModeId	string	操作模式 ID
unlockName	string	解锁名称

函数定义示例

/**
 * 添加解锁方式
 */
export function addMemberUnlockMethod(
  params: AddMemberUnlockMethodParams
): Promise<AddMemberUnlockMethodResult>

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

删除解锁方式

removeMemberUnlockMethod

引入

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

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

参数

RemoveMemberUnlockMethodParams

属性	类型	必填	说明
devId	string	是	设备 ID
opmodeId	number	是	操作模式 ID

返回

RemoveMemberUnlockMethodResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 删除解锁方式
 */
export function removeMemberUnlockMethod(
  params: RemoveMemberUnlockMethodParams
): Promise<RemoveMemberUnlockMethodResult>

发送设置特殊解锁方式的验证码

sendSpecialUnlockVerifyCode

引入

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

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

参数

SendSpecialUnlockVerifyCodeParams

属性	类型	必填	说明
account	string	是	用户账号

返回

SendSpecialUnlockVerifyCodeResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 发送设置特殊解锁方式的验证码
 */
export function sendSpecialUnlockVerifyCode(
  params: SendSpecialUnlockVerifyCodeParams
): Promise<SendSpecialUnlockVerifyCodeResult>

更新成员的解锁方式

updateMemberUnlockMode

引入

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

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

参数

UpdateMemberUnlockModeParams

属性	类型	必填	说明
devId	string	是	设备 ID
opModeId	number	是	操作模式 ID
unlockName	string	否	解锁名称
unlockAttr	number	是	解锁属性
unlockDetail	string	是	解锁详细信息
notifyInfo	NotifyInfo	否	通知信息

返回

UpdateMemberUnlockModeResult

boolean，表示操作是否成功。

函数定义示例

/**
 * 更新成员的解锁方式
 */
export function updateMemberUnlockMode(
  params: UpdateMemberUnlockModeParams
): Promise<UpdateMemberUnlockModeResult>

查询某个解锁方式的详情

getUnlockMethodDetail

引入

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

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

参数

UnlockMethodDetailParams

属性	类型	必填	说明
devId	string	是	设备 ID
opModeId	number	是	操作模式 ID

返回

UnlockMethodDetailResult

结构包含解锁方式的详细信息。

函数定义示例

/**
 * 查询某个解锁方式的详情
 */
export function getUnlockMethodDetail(
  params: UnlockMethodDetailParams
): Promise<UnlockMethodDetailResult>

获取创建密码时的序号

getCreatePasswordSN

引入

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

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

参数

GetPasswordSNParams

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

返回

GetPasswordSNResult

number，表示创建密码时的序号。

函数定义示例

/**
 * 获取创建密码时的序号
 */
export function getCreatePasswordSN(params: GetPasswordSNParams): Promise<GetPasswordSNResult>

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