IOrganizationUsersQuery
Service to query valid filter elements for particular filter.
export interface IOrganizationUsersQuery
Methods
Method | Description |
|---|---|
Starts the organization users query. | |
Sets filter for the query. | |
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
Sets number of users to return per page. Default size is specific per backend |
Method details
IOrganizationUsersQuery.query()method
Starts the organization users query.
query(): Promise<IOrganizationUsersQueryResult>;
Returns
Promise<IOrganizationUsersQueryResult>
promise of first page of the results
IOrganizationUsersQuery.withFilter()method
Sets filter for the query.
withFilter(filter: {
workspace?: string;
group?: string;
name?: string;
dataSource?: string;
email?: string;
}): IOrganizationUsersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | { workspace?: string; group?: string; name?: string; dataSource?: string; email?: string; } | filter to apply |
Returns
organization users query
IOrganizationUsersQuery.withPage()method
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withPage(page: number): IOrganizationUsersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
organization users query
IOrganizationUsersQuery.withSize()method
Sets number of users to return per page. Default size is specific per backend
withSize(size: number): IOrganizationUsersQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of organization users per page; must be a positive number |
Returns
organization users query