Edit

Share via

InstalledExtension interface

  • Reference
Package:
azure-devops-extension-api

Represents a VSTS extension along with its installation state

Extends
ExtensionManifest

Properties

extensionId

The friendly extension id for this extension - unique for a given publisher.
extensionName

The display name of the extension.
files

This is the set of files available from the extension.
flags

Extension flags relevant to contribution consumers
installState

Information about this particular installation of the extension
lastPublished

This represents the date/time the extensions was last updated in the gallery. This doesnt mean this version was updated the value represents changes to any and all versions of the extension.
publisherId

Unique id of the publisher of this extension
publisherName

The display name of the publisher
registrationId

Unique id for this extension (the same id is used for all versions of a single extension)
version

Version of this extension

Inherited Properties

baseUri

Uri used as base for other relative uri's defined in extension
constraints

List of shared constraints defined by this extension
contributions

List of contributions made by this extension
contributionTypes

List of contribution types defined by this extension
demands

List of explicit demands required by this extension
eventCallbacks

Collection of endpoints that get called when particular extension events occur
fallbackBaseUri

Secondary location that can be used as base for other relative uri's defined in extension
language

Language Culture Name set by the Gallery
licensing

How this extension behaves with respect to licensing
manifestVersion

Version of the extension manifest format/content
restrictedTo

Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.
scopes

List of all oauth scopes required by this extension
serviceInstanceType

The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed

Property Details

extensionId

The friendly extension id for this extension - unique for a given publisher.

extensionId: string

Property Value

string

extensionName

The display name of the extension.

extensionName: string

Property Value

string

files

This is the set of files available from the extension.

files: ExtensionFile[]

Property Value

ExtensionFile[]

flags

Extension flags relevant to contribution consumers

flags: ExtensionFlags

Property Value

ExtensionFlags

installState

Information about this particular installation of the extension

installState: InstalledExtensionState

Property Value

InstalledExtensionState

lastPublished

This represents the date/time the extensions was last updated in the gallery. This doesnt mean this version was updated the value represents changes to any and all versions of the extension.

lastPublished: Date

Property Value

Date

publisherId

Unique id of the publisher of this extension

publisherId: string

Property Value

string

publisherName

The display name of the publisher

publisherName: string

Property Value

string

registrationId

Unique id for this extension (the same id is used for all versions of a single extension)

registrationId: string

Property Value

string

version

Version of this extension

version: string

Property Value

string

Inherited Property Details

baseUri

Uri used as base for other relative uri's defined in extension

baseUri: string

Property Value

string

Inherited From ExtensionManifest.baseUri

constraints

List of shared constraints defined by this extension

constraints: ContributionConstraint[]

Property Value

ContributionConstraint[]

Inherited From ExtensionManifest.constraints

contributions

List of contributions made by this extension

contributions: Contribution[]

Property Value

Contribution[]

Inherited From ExtensionManifest.contributions

contributionTypes

List of contribution types defined by this extension

contributionTypes: ContributionType[]

Property Value

ContributionType[]

Inherited From ExtensionManifest.contributionTypes

demands

List of explicit demands required by this extension

demands: string[]

Property Value

string[]

Inherited From ExtensionManifest.demands

eventCallbacks

Collection of endpoints that get called when particular extension events occur

eventCallbacks: ExtensionEventCallbackCollection

Property Value

ExtensionEventCallbackCollection

Inherited From ExtensionManifest.eventCallbacks

fallbackBaseUri

Secondary location that can be used as base for other relative uri's defined in extension

fallbackBaseUri: string

Property Value

string

Inherited From ExtensionManifest.fallbackBaseUri

language

Language Culture Name set by the Gallery

language: string

Property Value

string

Inherited From ExtensionManifest.language

licensing

How this extension behaves with respect to licensing

licensing: ExtensionLicensing

Property Value

ExtensionLicensing

Inherited From ExtensionManifest.licensing

manifestVersion

Version of the extension manifest format/content

manifestVersion: number

Property Value

number

Inherited From ExtensionManifest.manifestVersion

restrictedTo

Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.

restrictedTo: string[]

Property Value

string[]

Inherited From ExtensionManifest.restrictedTo

scopes

List of all oauth scopes required by this extension

scopes: string[]

Property Value

string[]

Inherited From ExtensionManifest.scopes

serviceInstanceType

The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed

serviceInstanceType: string

Property Value

string

Inherited From ExtensionManifest.serviceInstanceType