PublisherEvent interface

Wrapper around an event which is being published

Properties

diagnostics

Add key/value pairs which will be stored with a published notification in the SH service DB. This key/value pairs are for diagnostic purposes only and will have not effect on the delivery of a notification.

event

The event being published

isFilteredEvent

Gets or sets flag for filtered events

notificationData

Additional data that needs to be sent as part of notification to complement the Resource data in the Event

otherResourceVersions

Gets or sets the array of older supported resource versions.

publisherInputFilters

Optional publisher-input filters which restricts the set of subscriptions which are triggered by the event

subscription

Gets or sets matched hooks subscription which caused this event.

Property Details

diagnostics

Add key/value pairs which will be stored with a published notification in the SH service DB. This key/value pairs are for diagnostic purposes only and will have not effect on the delivery of a notification.

diagnostics: {[key: string]: string}

Property Value

{[key: string]: string}

event

The event being published

event: Event

Property Value

isFilteredEvent

Gets or sets flag for filtered events

isFilteredEvent: boolean

Property Value

boolean

notificationData

Additional data that needs to be sent as part of notification to complement the Resource data in the Event

notificationData: {[key: string]: string}

Property Value

{[key: string]: string}

otherResourceVersions

Gets or sets the array of older supported resource versions.

otherResourceVersions: VersionedResource[]

Property Value

publisherInputFilters

Optional publisher-input filters which restricts the set of subscriptions which are triggered by the event

publisherInputFilters: InputFilter[]

Property Value

subscription

Gets or sets matched hooks subscription which caused this event.

subscription: Subscription

Property Value