NotificationEventType interface
Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type.
Properties
category | |
color | Gets or sets the color representing this event type. Example: rgb(128,245,211) or #fafafa |
custom |
|
event |
|
fields | |
has |
|
icon | Gets or sets the icon representing this event type. Can be a URL or a CSS class. Example: css://some-css-class |
id | Gets or sets the unique identifier of this event definition. |
name | Gets or sets the name of this event definition. |
roles | |
supported |
Gets or sets the scopes that this event type supports |
url | Gets or sets the rest end point to get this event type details (fields, fields types) |
Property Details
category
color
Gets or sets the color representing this event type. Example: rgb(128,245,211) or #fafafa
color: string
Property Value
string
customSubscriptionsAllowed
customSubscriptionsAllowed: boolean
Property Value
boolean
eventPublisher
fields
fields: {[key: string]: NotificationEventField}
Property Value
{[key: string]: NotificationEventField}
hasInitiator
hasInitiator: boolean
Property Value
boolean
icon
Gets or sets the icon representing this event type. Can be a URL or a CSS class. Example: css://some-css-class
icon: string
Property Value
string
id
Gets or sets the unique identifier of this event definition.
id: string
Property Value
string
name
Gets or sets the name of this event definition.
name: string
Property Value
string
roles
supportedScopes
Gets or sets the scopes that this event type supports
supportedScopes: string[]
Property Value
string[]
url
Gets or sets the rest end point to get this event type details (fields, fields types)
url: string
Property Value
string