interface
Source: index.ts ↗
IWorkspaceUsersQuery
Service to query users for current workspace
export interface IWorkspaceUsersQuery
Methods
Method | Description |
|---|---|
Starts the users query. | |
Starts the users query. | |
Allows to specify advanced options for the users query. |
Method details
IWorkspaceUsersQuery.query()method
Starts the users query.
query(): Promise<IWorkspaceUsersQueryResult>;
Returns
Promise<IWorkspaceUsersQueryResult>
promise of first page of the results
IWorkspaceUsersQuery.queryAll()method
Starts the users query.
queryAll(): Promise<IWorkspaceUser[]>;
Returns
Promise<IWorkspaceUser[]>
promise with a list of all users matching the specified options
IWorkspaceUsersQuery.withOptions()method
Allows to specify advanced options for the users query.
withOptions(options: IWorkspaceUsersQueryOptions): IWorkspaceUsersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
options | advanced options |
Returns
users query