Compartir a través de

FavoriteRestClient class

  • Referencia
Paquete:
azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends
RestClientBase

Constructores

FavoriteRestClient(IVssRestClientOptions)

Métodos

createFavorite(FavoriteCreateParameters)
createFavoriteOfOwner(FavoriteCreateParameters, string, string)
deleteFavoriteById(string, string, string, string)
deleteFavoriteOfOwnerById(string, string, string, string, string, string)
getFavoriteByArtifact(string, string, string, string, boolean)
getFavoriteById(string, string, string, string, boolean)
getFavoriteOfOwnerById(string, string, string, string, string, string, boolean)
getFavoriteProviders(boolean)
getFavorites(string, string, string, boolean)
getFavoritesOfOwner(string, string, string, string, string, boolean)

Detalles del constructor

FavoriteRestClient(IVssRestClientOptions) 

new FavoriteRestClient(options: IVssRestClientOptions)

Parámetros

options
IVssRestClientOptions

Detalles del método

createFavorite(FavoriteCreateParameters) 

function createFavorite(favorite: FavoriteCreateParameters): Promise<Favorite>

Parámetros

favorite
FavoriteCreateParameters

Devoluciones

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string) 

function createFavoriteOfOwner(favorite: FavoriteCreateParameters, ownerScopeType: string, ownerScopeId: string): Promise<Favorite>

Parámetros

favorite
FavoriteCreateParameters
ownerScopeType

string

ownerScopeId

string

Devoluciones

Promise<Favorite>

deleteFavoriteById(string, string, string, string) 

function deleteFavoriteById(favoriteId: string, artifactType: string, artifactScopeType: string, artifactScopeId?: string): Promise<void>

Parámetros

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Devoluciones

Promise<void>

deleteFavoriteOfOwnerById(string, string, string, string, string, string) 

function deleteFavoriteOfOwnerById(favoriteId: string, ownerScopeType: string, ownerScopeId: string, artifactType: string, artifactScopeType: string, artifactScopeId?: string): Promise<void>

Parámetros

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Devoluciones

Promise<void>

getFavoriteByArtifact(string, string, string, string, boolean) 

function getFavoriteByArtifact(artifactType: string, artifactId: string, artifactScopeType: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite>

Parámetros

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Devoluciones

Promise<Favorite>

getFavoriteById(string, string, string, string, boolean) 

function getFavoriteById(favoriteId: string, artifactScopeType: string, artifactType: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite>

Parámetros

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Devoluciones

Promise<Favorite>

getFavoriteOfOwnerById(string, string, string, string, string, string, boolean) 

function getFavoriteOfOwnerById(favoriteId: string, ownerScopeType: string, ownerScopeId: string, artifactScopeType: string, artifactType: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite>

Parámetros

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Devoluciones

Promise<Favorite>

getFavoriteProviders(boolean) 

function getFavoriteProviders(faultInMissingHost?: boolean): Promise<FavoriteProvider[]>

Parámetros

faultInMissingHost

boolean

Devoluciones

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean) 

function getFavorites(artifactType?: string, artifactScopeType?: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite[]>

Parámetros

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Devoluciones

Promise<Favorite[]>

getFavoritesOfOwner(string, string, string, string, string, boolean) 

function getFavoritesOfOwner(ownerScopeType: string, ownerScopeId: string, artifactType?: string, artifactScopeType?: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite[]>

Parámetros

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Devoluciones

Promise<Favorite[]>