getUnlockGuide
Requires:
@ray-js/lock-sdk≥1.2.0
Method signature
getUnlockGuide(type: "finger" | "face" | "password" | "card" | "fingerVein" | "hand" | "eye")Description
Get the guide image or video for the specified unlock method type
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "finger" | "face" | "password" | "card" | "fingerVein" | "hand" | "eye" | Yes | Unlocking method type |
Return Value
Type: Promise<UnlockGuide>
Guide data or null
UnlockGuide
| Property | Type | Description |
|---|---|---|
videoUrl | string | Onboarding video URL |
picUrl | string | Onboarding image URL |
expireTime | number | Resource expiration time |
Valid Values
type
| Value | Description | Since |
|---|---|---|
finger | - | - |
face | - | - |
password | - | - |
card | - | - |
fingerVein | - | - |
hand | - | - |
eye | - | - |