INotificationChannelMetadataObjectBase
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Shared base interface for all notification channel metadata objects.
export interface INotificationChannelMetadataObjectBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Allowed recipients of notifications from this channel. If creator is specified, the notification will be sent to the creator of the report only. If internal is specified, the notification will be sent to all internal users. | |||
string | (BETA) (Optional) Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}. | ||
(BETA) (Optional) Dashboard link visibility. | |||
(BETA) Type of the destination of the notification channel. | |||
“notificationChannel” | (BETA) |
Property details
INotificationChannelMetadataObjectBase.allowedRecipientspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Allowed recipients of notifications from this channel.
If creator is specified, the notification will be sent to the creator of the report only. If internal is specified, the notification will be sent to all internal users.
allowedRecipients?: NotificationChannelAllowedRecipients;
INotificationChannelMetadataObjectBase.customDashboardUrlpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}.
customDashboardUrl?: string;
INotificationChannelMetadataObjectBase.dashboardLinkVisibilitypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dashboard link visibility.
dashboardLinkVisibility?: NotificationChannelDashboardLinkVisibility;
INotificationChannelMetadataObjectBase.destinationTypepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Type of the destination of the notification channel.
destinationType: NotificationChannelDestinationType;
INotificationChannelMetadataObjectBase.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
type: "notificationChannel";