getUsers(params?: GetUsersParams)

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

Description

Query the user list with pagination/keywords.

Parameters

ParameterTypeRequiredDescription
NoQuery parameters (page: page number, pageSize: items per page, keyword: search keyword)

Return Value

Type: Promise<getUsersResult>
User list result
getUsersResult
PropertyTypeDescription
User list
hasMorebooleanWhether more data is available

Referenced Types

interfaceUserInfo
PropertyTypeDescription
userIdstringCloud user ID
lockUserIdnumberLock‑side user ID
avatarUrlstringAvatar URL
backHomeNotifyAttrnumberHome arrival notification attribute flags
effectiveFlagnumberEffective state flag
nickNamestringNickname
offlineUnlockbooleanWhether offline unlocking is supported
Effective time range and repeat rules
Details grouped by unlock method type
userContactstringUser contact (account)
userTypeUserTypeUser type
isFamilyUserbooleanWhether the user is a household member
typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];
enumUserType
ValueActual ValueDescription
UserType.ADMIN10Administrator
UserType.MEMBER20Member
UserType.UNKNOW30Anonymous
UserType.SHARE40Shared member
UserType.OWNER50Home owner

Valid Values

Week
ValueDescriptionSince
0--
1--
UserInfo.unlockDetails.type
ValueDescriptionSince
finger--
face--
password--
card--
fingerVein--
hand--
eye--
UserType
ValueDescriptionSince
10Administrator-
20Member-
30Anonymous-
40Shared member-
50Home owner-

Examples

import { getUsers } from '@ray-js/lock-sdk';
const users = await getUsers({ page: 1, pageSize: 10 });