IAgentsQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Service to query agents.
export interface IAgentsQuery
Methods
Method | Description |
|---|---|
(ALPHA) Starts the agents query. | |
(ALPHA) Starts the agents query. | |
(ALPHA) Sets filter for the query. | |
(ALPHA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
(ALPHA) Sets number of agents to return per page. Default size: 100 | |
(ALPHA) Sets sorting for the query. |
Method details
IAgentsQuery.query()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Starts the agents query.
query(): Promise<IAgentsQueryResult>;
Returns
Promise<IAgentsQueryResult>
promise of first page of the results
IAgentsQuery.queryAll()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Starts the agents query.
queryAll(): Promise<IAgent[]>;
Returns
Promise<IAgent[]>
promise with a list of all agents matching the specified options
IAgentsQuery.withFilter()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sets filter for the query.
withFilter(filter: {
name?: string;
isPreview?: boolean;
}): IAgentsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | { name?: string; isPreview?: boolean; } | filter object with optional name for name-based search, and optional |
Returns
agents query
IAgentsQuery.withPage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
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): IAgentsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
agents query
IAgentsQuery.withSize()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sets number of agents to return per page. Default size: 100
withSize(size: number): IAgentsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of agents per page, must be a positive number |
Returns
agents query
IAgentsQuery.withSorting()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sets sorting for the query.
withSorting(sort: string[]): IAgentsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
sort | string[] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Returns
agents query