ContributionConstraint interface

  • Reference
Package:
azure-devops-extension-api

Specifies a constraint that can be used to dynamically include/exclude a given contribution

Properties

group

An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).
id

Fully qualified identifier of a shared constraint
inverse

If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)
name

Name of the IContributionFilter plugin
properties

Properties that are fed to the contribution filter class
relationships

Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.

Property Details

group

An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).

group: number

Property Value

number

id

Fully qualified identifier of a shared constraint

id: string

Property Value

string

inverse

If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)

inverse: boolean

Property Value

boolean

name

Name of the IContributionFilter plugin

name: string

Property Value

string

properties

Properties that are fed to the contribution filter class

properties: any

Property Value

any

relationships

Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.

relationships: string[]

Property Value

string[]