Favorite interface

  • Reference
Package:
azure-devops-extension-api

Implementation of Favorite contract following modern storage

Properties

artifactId

ID of the favorited artifact, unique in context of this artifact type.
artifactIsDeleted

Indicates if the artifact described by this favorite could not be located.
artifactName

Last known name of the artifact.
artifactProperties

A dictionary of cached properties describing a Favorited artifact. Structure is generated by the service-side feature metadata provider handling this Artifact Type.
artifactScope

Artifact Scope - This object describes where an artifact is contained. e.g. Project Mandatory param for creating all favorites.
artifactType

Type of artifact.
creationDate

Date and time this Favorite was created on server.
id

Unique Id of the favorite item, defined by server at creation time.
owner

User identity, defined by server, based on active user context.
url

Fully-Qualified link to this Resource

Property Details

artifactId

ID of the favorited artifact, unique in context of this artifact type.

artifactId: string

Property Value

string

artifactIsDeleted

Indicates if the artifact described by this favorite could not be located.

artifactIsDeleted: boolean

Property Value

boolean

artifactName

Last known name of the artifact.

artifactName: string

Property Value

string

artifactProperties

A dictionary of cached properties describing a Favorited artifact. Structure is generated by the service-side feature metadata provider handling this Artifact Type.

artifactProperties: ArtifactProperties

Property Value

ArtifactProperties

artifactScope

Artifact Scope - This object describes where an artifact is contained. e.g. Project Mandatory param for creating all favorites.

artifactScope: ArtifactScope

Property Value

ArtifactScope

artifactType

Type of artifact.

artifactType: string

Property Value

string

creationDate

Date and time this Favorite was created on server.

creationDate: Date

Property Value

Date

id

Unique Id of the favorite item, defined by server at creation time.

id: string

Property Value

string

owner

User identity, defined by server, based on active user context.

owner: IdentityRef

Property Value

IdentityRef

url

Fully-Qualified link to this Resource

url: string

Property Value

string