FavoriteRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

FavoriteRestClient(IVssRestClientOptions)

Yöntemler

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)

Oluşturucu Ayrıntıları

FavoriteRestClient(IVssRestClientOptions)

new FavoriteRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createFavorite(FavoriteCreateParameters)

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

Parametreler

favorite

FavoriteCreateParameters

Döndürülenler

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string)

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

Parametreler

favorite

FavoriteCreateParameters

ownerScopeType

string

ownerScopeId

string

Döndürülenler

Promise<Favorite>

deleteFavoriteById(string, string, string, string)

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

Parametreler

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Döndürülenler

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>

Parametreler

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

Döndürülenler

Promise<void>

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

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

Parametreler

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Döndürülenler

Promise<Favorite>

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

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

Parametreler

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Döndürülenler

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>

Parametreler

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

Döndürülenler

Promise<Favorite>

getFavoriteProviders(boolean)

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

Parametreler

faultInMissingHost

boolean

Döndürülenler

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean)

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

Parametreler

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Döndürülenler

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

Parametreler

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

Döndürülenler

Promise<Favorite[]>