getUnlockMethodDetail(id: number)
Requires:
@ray-js/lock-sdk≥1.0.0
Description
Get unlock method details
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Record ID |
Return Value
Type: Promise<UnlockMethodDetail>
Unlock method details (parsed cloud record)
UnlockMethodDetail
| Property | Type | Description |
|---|---|---|
isBound | boolean | Whether bound to a cloud user |
type | "finger" | "face" | "password" | "card" | "fingerVein" | "hand" | "eye" | Unlock method type |
phase | number | Cloud stage/status value |
dpId | number | Corresponding DP numeric ID |
isSpecial | boolean | Whether it's a special unlock method |
unlockName | string | Unlock method name |
userId | string | Associated cloud user ID |
unlockId | number | Lock-side unlock instance ID |
lockUserId | number | Lock-side user ID |
id | string | Cloud unlock method record ID (string form) |
userType | number | User type (numeric) |
| Notification configuration; effective when `isSpecial` is true |
Error Code
| Error Code | Error Message |
|---|---|
1040 | Cloud: record does not exist (RECORD_NOT_EXIST) |
Referenced Types
interface
NotifyInfo| Property | Type | Description |
|---|---|---|
appSend | boolean | Whether to push App notifications |
msgSend | boolean | Whether to send SMS |
msgPhone | string | SMS recipient phone number (value present usually indicates SMS enabled) |
countryCode | string | SMS country code |
Valid Values
return.type
| Value | Description | Since |
|---|---|---|
finger | - | - |
face | - | - |
password | - | - |
card | - | - |
fingerVein | - | - |
hand | - | - |
eye | - | - |