Udostępnij za pośrednictwem

FavoriteRestClient class

  • Odwołanie
Pakiet:
azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends
RestClientBase

Konstruktory

FavoriteRestClient(IVssRestClientOptions)

Metody

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)

Szczegóły konstruktora

FavoriteRestClient(IVssRestClientOptions) 

new FavoriteRestClient(options: IVssRestClientOptions)

Parametry

options
IVssRestClientOptions

Szczegóły metody

createFavorite(FavoriteCreateParameters) 

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

Parametry

favorite
FavoriteCreateParameters

Zwraca

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string) 

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

Parametry

favorite
FavoriteCreateParameters
ownerScopeType

string

ownerScopeId

string

Zwraca

Promise<Favorite>

deleteFavoriteById(string, string, string, string) 

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

Parametry

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Zwraca

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>

Parametry

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Zwraca

Promise<void>

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

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

Parametry

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Zwraca

Promise<Favorite>

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

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

Parametry

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Zwraca

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>

Parametry

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Zwraca

Promise<Favorite>

getFavoriteProviders(boolean) 

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

Parametry

faultInMissingHost

boolean

Zwraca

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean) 

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

Parametry

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Zwraca

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

Parametry

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Zwraca

Promise<Favorite[]>