updateSharedUser

Requires:

@ray-js/lock-sdk≥1.2.0

Method signature

updateSharedUser(params: )

Description

Update a shared user (Bluetooth door lock).

Parameters

Parameter	Type	Required	Description
		Yes	Bluetooth key ID, name, validity, etc.

Return Value

Type: Promise<void>

None

Error Code

Error Code	Error Message
`1031`	Name length exceeds 20 characters
`1032`	effectiveType is limit but effective is not provided
`1033`	Validity start date not configured
`1034`	Validity end date not configured
`1010`	Start time cannot be later than end time
`1035`	weeks not configured for weekly repetition

Referenced Types

typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active

export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

Valid Values

`EffectiveConfig.repeat`

Value	Description	Since
`none`	-	-
`week`	-	-

`Week`

Value	Description	Since
`0`	-	-
`1`	-	-

`UpdateSharedUserParams.effectiveType`

Value	Description	Since
`once`	-	-
`permanent`	-	-
`limit`	-	-

Examples

import { updateSharedUser } from '@ray-js/lock-sdk';
await updateSharedUser({
  unlockBindingId: '1234567890',
  name: 'Zhang San',
  effectiveType: 'once',
});