getFitUsers()

Requires:
@ray-js/lock-sdk≥1.2.0

Description

Get the member (user) list for the accessory.

Parameters

None

Return Value

Type: Promise<FitUserItem[]>
Member list
FitUserItem
PropertyTypeDescription
userIdstringCloud user ID
lockUserIdnumberLock-side user ID
avatarUrlstringAvatar URL
nickNamestringNickname
userTypeUserTypeMember type: 10 Administrator / 20 Regular member / 30 Unnamed member / 50 Home owner.
userContactstringContact info (phone/email, etc.), sensitive data—please mask as needed on the business side
userTimeSetstringUnlock validity settings (passthrough string).
phasenumberStatus: 1 Normal, 3 Frozen.

Referenced Types

enumUserType
ValueActual ValueDescription
UserType.ADMIN10Administrator
UserType.MEMBER20Member
UserType.UNKNOW30Anonymous
UserType.SHARE40Shared member
UserType.OWNER50Home owner

Valid Values

UserType
ValueDescriptionSince
10Administrator-
20Member-
30Anonymous-
40Shared member-
50Home owner-

Examples

import { getFitUsers } from '@ray-js/lock-sdk';
const users = await getFitUsers();
console.log(users[0]?.nickName);