Dela via

FavoriteRestClient class

  • Referens
Paket:
azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:erna

Extends
RestClientBase

Konstruktorer

FavoriteRestClient(IVssRestClientOptions)

Metoder

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)

Konstruktorinformation

FavoriteRestClient(IVssRestClientOptions) 

new FavoriteRestClient(options: IVssRestClientOptions)

Parametrar

options
IVssRestClientOptions

Metodinformation

createFavorite(FavoriteCreateParameters) 

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

Parametrar

favorite
FavoriteCreateParameters

Returer

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string) 

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

Parametrar

favorite
FavoriteCreateParameters
ownerScopeType

string

ownerScopeId

string

Returer

Promise<Favorite>

deleteFavoriteById(string, string, string, string) 

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

Parametrar

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Returer

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>

Parametrar

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Returer

Promise<void>

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

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

Parametrar

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Returer

Promise<Favorite>

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

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

Parametrar

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Returer

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>

Parametrar

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Returer

Promise<Favorite>

getFavoriteProviders(boolean) 

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

Parametrar

faultInMissingHost

boolean

Returer

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean) 

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

Parametrar

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Returer

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

Parametrar

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Returer

Promise<Favorite[]>