INotificationChannelsQuery
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Service to query notification channels.
export interface INotificationChannelsQuery
Methods
Method | Description |
|---|---|
(BETA) Starts the notification channels query. | |
(BETA) Starts the notification channels query. | |
(BETA) Starts the notification channel identifiers query (lightweight, no sensitive data). | |
(BETA) Starts the notification channel identifiers query (lightweight, no sensitive data). | |
(BETA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
(BETA) Sets number of notification channels to return per page. Default size: 100 | |
(BETA) Sets sorting for the query. | |
(BETA) Sets type of the automation for the query. |
Method details
INotificationChannelsQuery.query()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the notification channels query.
query(): Promise<INotificationChannelsQueryResult>;
Returns
Promise<INotificationChannelsQueryResult>
promise of first page of the results
INotificationChannelsQuery.queryAll()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the notification channels query.
queryAll(): Promise<INotificationChannelMetadataObject[]>;
Returns
Promise<INotificationChannelMetadataObject[]>
promise with a list of all notification channels matching the specified options
INotificationChannelsQuery.queryAllIdentifiers()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the notification channel identifiers query (lightweight, no sensitive data).
queryAllIdentifiers(): Promise<INotificationChannelIdentifier[]>;
Returns
Promise<INotificationChannelIdentifier[]>
promise with a list of all notification channel identifiers matching the specified options
INotificationChannelsQuery.queryIdentifiers()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the notification channel identifiers query (lightweight, no sensitive data).
queryIdentifiers(): Promise<INotificationChannelIdentifiersQueryResult>;
Returns
Promise<INotificationChannelIdentifiersQueryResult>
promise of first page of the results
INotificationChannelsQuery.withPage()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
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): INotificationChannelsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
notification channels query
INotificationChannelsQuery.withSize()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets number of notification channels to return per page. Default size: 100
withSize(size: number): INotificationChannelsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of notification channels per page must be a positive number |
Returns
notification channels query
INotificationChannelsQuery.withSorting()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets sorting for the query.
withSorting(sort: string[]): INotificationChannelsQuery;
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
notification channels query
INotificationChannelsQuery.withTypes()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets type of the automation for the query.
withTypes(type: NotificationChannelDestinationType[]): INotificationChannelsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
type | type of the automation, e.g. “schedule” or “trigger” |
Returns
notification channels query