Contribution interface

An individual contribution made by an extension

Extends

Properties

constraints

List of constraints (filters) that should be applied to the availability of this contribution

includes

Includes is a set of contributions that should have this contribution included in their targets list.

properties

Properties/attributes of this contribution

restrictedTo

List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).

targets

The ids of the contribution(s) that this contribution targets. (parent contributions)

type

Id of the 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

constraints

List of constraints (filters) that should be applied to the availability of this contribution

constraints: ContributionConstraint[]

Property Value

includes

Includes is a set of contributions that should have this contribution included in their targets list.

includes: string[]

Property Value

string[]

properties

Properties/attributes of this contribution

properties: any

Property Value

any

restrictedTo

List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).

restrictedTo: string[]

Property Value

string[]

targets

The ids of the contribution(s) that this contribution targets. (parent contributions)

targets: string[]

Property Value

string[]

type

Id of the Contribution Type

type: string

Property Value

string

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