FavoriteProvider interface

  • Reference
Package:
azure-devops-extension-api

Exposes a provider of favorites.

Extends
FavoritesSecuredObject

Properties

artifactType

Favorite artifact type
artifactUri

URI for retrieving favorite artifacts
clientServiceIdentifier

contributed client side service that is available for this provider to provide dynamic associated data.
contributionId

Contribution Id
iconClass

Css class to be applied to the icon for the artifact.
iconName

Name of the fabric icon to be applied for the artifact
order

Group of favorites will be rendered in this order, 0 is top If 2 types share order, they will be coalesced into a single group
pluralName

Name used for rendering the title of each group of favorites
serviceIdentifier

Service identifier of the service.
serviceUri

Base URI of the service

Inherited Properties

token

Property Details

artifactType

Favorite artifact type

artifactType: string

Property Value

string

artifactUri

URI for retrieving favorite artifacts

artifactUri: string

Property Value

string

clientServiceIdentifier

contributed client side service that is available for this provider to provide dynamic associated data.

clientServiceIdentifier: string

Property Value

string

contributionId

Contribution Id

contributionId: string

Property Value

string

iconClass

Css class to be applied to the icon for the artifact.

iconClass: string

Property Value

string

iconName

Name of the fabric icon to be applied for the artifact

iconName: string

Property Value

string

order

Group of favorites will be rendered in this order, 0 is top If 2 types share order, they will be coalesced into a single group

order: number

Property Value

number

pluralName

Name used for rendering the title of each group of favorites

pluralName: string

Property Value

string

serviceIdentifier

Service identifier of the service.

serviceIdentifier: string

Property Value

string

serviceUri

Base URI of the service

serviceUri: string

Property Value

string

Inherited Property Details

token 

token: string

Property Value

string

Inherited From FavoritesSecuredObject.token