次の方法で共有


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