Interface NotificationEventType

Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type.

interface NotificationEventType {
    category?: NotificationEventTypeCategory;
    color?: string;
    customSubscriptionsAllowed?: boolean;
    eventPublisher?: NotificationEventPublisher;
    fields?: { [key: string]: NotificationEventField };
    hasInitiator?: boolean;
    icon?: string;
    id?: string;
    name?: string;
    roles?: NotificationEventRole[];
    supportedScopes?: string[];
    url?: string;
}

Properties

category? color? customSubscriptionsAllowed? eventPublisher? fields? hasInitiator? icon? id? name? roles? supportedScopes? url?

Properties

Optionalcategory

category?: NotificationEventTypeCategory

Optionalcolor

color?: string

Gets or sets the color representing this event type. Example: rgb(128,245,211) or #fafafa

OptionalcustomSubscriptionsAllowed

customSubscriptionsAllowed?: boolean

OptionaleventPublisher

eventPublisher?: NotificationEventPublisher

Optionalfields

fields?: { [key: string]: NotificationEventField }

OptionalhasInitiator

hasInitiator?: boolean

Optionalicon

icon?: string

Gets or sets the icon representing this event type. Can be a URL or a CSS class. Example: css://some-css-class

Optionalid

id?: string

Gets or sets the unique identifier of this event definition.

Optionalname

name?: string

Gets or sets the name of this event definition.

Optionalroles

roles?: NotificationEventRole[]

OptionalsupportedScopes

supportedScopes?: string[]

Gets or sets the scopes that this event type supports

Optionalurl

url?: string

Gets or sets the rest end point to get this event type details (fields, fields types)

Settings

Member Visibility

On This Page

Properties