Condividi tramite

FavoriteRestClient class

  • Riferimento
Pacchetto:
azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends
RestClientBase

Costruttori

FavoriteRestClient(IVssRestClientOptions)

Metodi

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)

Dettagli costruttore

FavoriteRestClient(IVssRestClientOptions) 

new FavoriteRestClient(options: IVssRestClientOptions)

Parametri

options
IVssRestClientOptions

Dettagli metodo

createFavorite(FavoriteCreateParameters) 

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

Parametri

favorite
FavoriteCreateParameters

Restituisce

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string) 

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

Parametri

favorite
FavoriteCreateParameters
ownerScopeType

string

ownerScopeId

string

Restituisce

Promise<Favorite>

deleteFavoriteById(string, string, string, string) 

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

Parametri

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Restituisce

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>

Parametri

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Restituisce

Promise<void>

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

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

Parametri

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Restituisce

Promise<Favorite>

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

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

Parametri

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Restituisce

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>

Parametri

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Restituisce

Promise<Favorite>

getFavoriteProviders(boolean) 

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

Parametri

faultInMissingHost

boolean

Restituisce

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean) 

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

Parametri

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Restituisce

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[]>

Parametri

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Restituisce

Promise<Favorite[]>