addSharedUser

Requires:

@ray-js/lock-sdk≥1.2.0

Method signature

addSharedUser(params: )

Description

Add a shared user (Bluetooth door lock).

Parameters

Parameter	Type	Required	Description
		Yes	Country code, account, name, validity, etc.

Return Value

Type: Promise<AddSharedUserResult>

Add result

AddSharedUserResult

Property	Type	Description
`id`	string	Record ID
`name`	string	Name
`userExist`	boolean	Whether a corresponding App account exists

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
`1083`	Name contains unsupported emojis
`1084`	Invalid share account
`1085`	Virtual key unavailable (or other pre-share checks failed)
`1086`	Device does not exist
`1038`	Shared user name already exists

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

`AddSharedUserParams.effectiveType`

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

`EffectiveConfig.repeat`

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

`Week`

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

Examples

import { addSharedUser } from '@ray-js/lock-sdk';
await addSharedUser({
  countryCode: '86',
  account: '13800138000',
  name: 'Zhang San',
  effectiveType: 'once',
});