fitStartAddUnlockMethod - Start the multi-stage flow of adding an unlock method on the accessory, such as fingerprint, card or face.

fitStartAddUnlockMethod(params: FitStartAddUnlockMethodParams)

Requires:

@ray-js/lock-sdk≥1.2.0

Description

Start a multi-stage process on the accessory side to add an unlock method (fingerprint/card/face, etc.)

Parameters

Parameter	Type	Required	Description
		Yes	Launch parameters

Return Value

Type: Promise<FitStartAddUnlockMethodResult>

{ total }: total number of steps; subsequent steps are pushed via onFitAddUnlockMethod

FitStartAddUnlockMethodResult

Property	Type	Description
`total`	number	Total number of steps (returned by the device)

Error Code

Error Code	Error Message
`1014`	This unlock method type is not supported
`1001`	Device is offline
`1088`	Accessory is not bound to a lock
`1089`	Target lock not found
`1002`	Operation timed out
`1015`	~1025 Device reported start failure (status 0~10)
`1026`	Device reported start failure (status 0xfe)
`1027`	Device reported an unknown stage

Valid Values

`FitStartAddUnlockMethodParams.type`

Value	Description	Since
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

Examples

import { fitStartAddUnlockMethod, onFitAddUnlockMethod } from '@ray-js/lock-sdk';
onFitAddUnlockMethod((event) => console.log(event));
const { total } = await fitStartAddUnlockMethod({
  lockDevId: 'lock_xxx',
  userId: 'user_001',
  type: 'finger',
});