다음을 통해 공유


FavoriteRestClient class

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

생성자

FavoriteRestClient(IVssRestClientOptions)

메서드

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)

생성자 세부 정보

FavoriteRestClient(IVssRestClientOptions)

new FavoriteRestClient(options: IVssRestClientOptions)

매개 변수

메서드 세부 정보

createFavorite(FavoriteCreateParameters)

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

매개 변수

반환

Promise<Favorite>

createFavoriteOfOwner(FavoriteCreateParameters, string, string)

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

매개 변수

ownerScopeType

string

ownerScopeId

string

반환

Promise<Favorite>

deleteFavoriteById(string, string, string, string)

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

매개 변수

favoriteId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

반환

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>

매개 변수

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

반환

Promise<void>

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

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

매개 변수

artifactType

string

artifactId

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

반환

Promise<Favorite>

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

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

매개 변수

favoriteId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

반환

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>

매개 변수

favoriteId

string

ownerScopeType

string

ownerScopeId

string

artifactScopeType

string

artifactType

string

artifactScopeId

string

includeExtendedDetails

boolean

반환

Promise<Favorite>

getFavoriteProviders(boolean)

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

매개 변수

faultInMissingHost

boolean

반환

Promise<FavoriteProvider[]>

getFavorites(string, string, string, boolean)

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

매개 변수

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

반환

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

매개 변수

ownerScopeType

string

ownerScopeId

string

artifactType

string

artifactScopeType

string

artifactScopeId

string

includeExtendedDetails

boolean

반환

Promise<Favorite[]>