ContributionType interface

  • Reference
Package:
azure-devops-extension-api

A contribution type, given by a json schema

Extends
ContributionBase

Properties

indexed

Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.
name

Friendly name of the contribution/type
properties

Describes the allowed properties for this contribution type

Inherited Properties

description

Description of the contribution/type
id

Fully qualified identifier of the contribution/type
visibleTo

VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: "ms" - Means only the "ms" publisher can reference this. "ms.vss-web" - Means only the "vss-web" extension from the "ms" publisher can reference this.

Property Details

indexed

Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.

indexed: boolean

Property Value

boolean

name

Friendly name of the contribution/type

name: string

Property Value

string

properties

Describes the allowed properties for this contribution type

properties: {[key: string]: ContributionPropertyDescription}

Property Value

{[key: string]: ContributionPropertyDescription}

Inherited Property Details

description

Description of the contribution/type

description: string

Property Value

string

Inherited From ContributionBase.description

id

Fully qualified identifier of the contribution/type

id: string

Property Value

string

Inherited From ContributionBase.id

visibleTo

VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: "ms" - Means only the "ms" publisher can reference this. "ms.vss-web" - Means only the "vss-web" extension from the "ms" publisher can reference this.

visibleTo: string[]

Property Value

string[]

Inherited From ContributionBase.visibleTo