IOrganizationNotificationChannelService
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
This service provides access to organization notifications channels.
export interface IOrganizationNotificationChannelService
Methods
Method | Description |
|---|---|
(BETA) | |
(BETA) Delete notification channel | |
(BETA) | |
(BETA) Query list of notification channels | |
(BETA) Test notification channel | |
(BETA) Update existing notification channel |
Method details
IOrganizationNotificationChannelService.createNotificationChannel()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
createNotificationChannel(notificationChannel: INotificationChannelMetadataObjectDefinition): Promise<INotificationChannelMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
notificationChannel |
Returns
Promise<INotificationChannelMetadataObject>
IOrganizationNotificationChannelService.deleteNotificationChannel()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Delete notification channel
deleteNotificationChannel(id: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | id of the notification channel |
Returns
Promise<void>
Promise resolved when the notification channel is deleted.
IOrganizationNotificationChannelService.getNotificationChannel()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
getNotificationChannel(id: string): Promise<INotificationChannelMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string |
Returns
Promise<INotificationChannelMetadataObject>
IOrganizationNotificationChannelService.getNotificationChannelsQuery()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Query list of notification channels
getNotificationChannelsQuery(): INotificationChannelsQuery;
Returns
IOrganizationNotificationChannelService.testNotificationChannel()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Test notification channel
testNotificationChannel(channel: INotificationChannelMetadataObjectDefinition, externalRecipients?: INotificationChannelExternalRecipient[]): Promise<INotificationChannelTestResponse>;
Parameters
Parameter | Type | Description |
|---|---|---|
channel | definition of the channel | |
externalRecipients | (Optional) external recipients of the test result |
Returns
Promise<INotificationChannelTestResponse>
Promise resolved with test response.
IOrganizationNotificationChannelService.updateNotificationChannel()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Update existing notification channel
updateNotificationChannel(notificationChannel: INotificationChannelMetadataObject): Promise<INotificationChannelMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
notificationChannel | definition of the notification channel |
Returns
Promise<INotificationChannelMetadataObject>
Promise resolved with updated notification channel.