useSiteUsers

useSiteUsers( options?: SiteUsersOptions, deps?: any[]): ISiteUserInfo[] | null | undefined;

Returns site users.

Examples

Get all site users,

const siteUsers = useSiteUsers();

Query site users,

const topFiveUser = useSiteUsers({ query: { select: ["Title", "Id", "LoginName"], top: 5 } });

Parameters

NameTypeDescriptionTracked for changes
options?SiteUsersOptionsuseSiteUsers hook optionsPartially
deps?DependencyListHook dependency list.Yes