Edit

Share via

NotificationEventField interface

  • Reference
Package:
azure-devops-extension-api

Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type.

Properties

fieldType

Gets or sets the type of this field.
id

Gets or sets the unique identifier of this field.
name

Gets or sets the name of this field.
path

Gets or sets the path to the field in the event object. This path can be either Json Path or XPath, depending on if the event will be serialized into Json or XML
supportedScopes

Gets or sets the scopes that this field supports. If not specified then the event type scopes apply.

Property Details

fieldType

Gets or sets the type of this field.

fieldType: NotificationEventFieldType

Property Value

NotificationEventFieldType

id

Gets or sets the unique identifier of this field.

id: string

Property Value

string

name

Gets or sets the name of this field.

name: string

Property Value

string

path

Gets or sets the path to the field in the event object. This path can be either Json Path or XPath, depending on if the event will be serialized into Json or XML

path: string

Property Value

string

supportedScopes

Gets or sets the scopes that this field supports. If not specified then the event type scopes apply.

supportedScopes: string[]

Property Value

string[]