Type Alias NotificationItem

Notification result item

type NotificationItem = {
    isManageableInHub?: boolean;
    isSubscribable: boolean;
    notificationNamePattern: string;
    presentationInfo?: {
        friendlyName?: string;
        scopeFriendlyNames?: Record<string, string>;
        scopes?: string[];
    };
    subscriptionInfo?: {
        action: string;
        resourceId?: string;
        resourceSubType?: string;
        resourceType: string;
        target?: string;
    };
    transports: string[];
}
Index

Properties

isManageableInHub? isSubscribable notificationNamePattern presentationInfo? subscriptionInfo? transports

Properties

isManageableInHub?: boolean

Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array.

isSubscribable: boolean

Indicates if the notification can be subscribed to by users. If true, the object will also contain 'subscriptionInfo' object

notificationNamePattern: string

Notification name pattern that will trigger this notification e.g resource.action

presentationInfo?: {
    friendlyName?: string;
    scopeFriendlyNames?: Record<string, string>;
    scopes?: string[];
}

Object containing information pertaining to the presentaion of a notification in the UI

Type Declaration

  • OptionalfriendlyName?: string

    Localized, human-readable string representing the name of the notification suitable to use in a UI

  • OptionalscopeFriendlyNames?: Record<string, string>

    Friendly name to be displayed for each scope.

  • Optionalscopes?: string[]

    Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI

subscriptionInfo?: {
    action: string;
    resourceId?: string;
    resourceSubType?: string;
    resourceType: string;
    target?: string;
}

Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc.

transports: string[]

Type of Transport e.g. Email, Notification, Slack message etc...

Settings

Member Visibility

On This Page

Properties