Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventSubscriptionFilter

Package version

Filter for the Event Subscription.

Hierarchy

  • EventSubscriptionFilter

Index

Properties

Optional advancedFilters

advancedFilters: AdvancedFilterUnion[]

An array of advanced filters that are used for filtering event subscriptions.

Optional enableAdvancedFilteringOnArrays

enableAdvancedFilteringOnArrays: undefined | false | true

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

Optional includedEventTypes

includedEventTypes: string[]

A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.

Optional isSubjectCaseSensitive

isSubjectCaseSensitive: undefined | false | true

Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.

Optional subjectBeginsWith

subjectBeginsWith: undefined | string

An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.

Optional subjectEndsWith

subjectEndsWith: undefined | string

An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

Generated using TypeDoc