IUseWorkspaceUsersSearchResult
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
What useWorkspaceUsersSearch() returns.
export interface IUseWorkspaceUsersSearchResult
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) True while the search debounce window or a query is open. | ||
() => void | (BETA) Starts the first fetch — nothing loads on mount until this is called (wire it to the control’s open/focus). After an error it doubles as retry. | ||
(search: string) => void | (BETA) Sets the search string; the query fires after a 300 ms debounce. | ||
string | (BETA) The current, not yet debounced, search string. | ||
IWorkspaceUser[] | undefined | (BETA) The workspace users of the last settled query; undefined until the first query settles. | ||
GoodDataSdkError | undefined | (BETA) The last query’s error, if it failed. |
Property details
IUseWorkspaceUsersSearchResult.isLoadingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
True while the search debounce window or a query is open.
isLoading: boolean;
IUseWorkspaceUsersSearchResult.onActivatepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the first fetch — nothing loads on mount until this is called (wire it to the control’s open/focus). After an error it doubles as retry.
onActivate: () => void;
IUseWorkspaceUsersSearchResult.onSearchpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the search string; the query fires after a 300 ms debounce.
onSearch: (search: string) => void;
IUseWorkspaceUsersSearchResult.searchpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The current, not yet debounced, search string.
search: string;
IUseWorkspaceUsersSearchResult.userspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The workspace users of the last settled query; undefined until the first query settles.
users: IWorkspaceUser[] | undefined;
IUseWorkspaceUsersSearchResult.usersErrorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The last query’s error, if it failed.
usersError: GoodDataSdkError | undefined;