FavoriteRestClient class
應該使用 (衍生自) 的基類，向 VSS REST API 提出要求
- Extends
建構函式
| Favorite |
方法
建構函式詳細資料
FavoriteRestClient(IVssRestClientOptions)
方法詳細資料
createFavorite(FavoriteCreateParameters)
function createFavorite(favorite: FavoriteCreateParameters): Promise<Favorite>參數
- favorite
- FavoriteCreateParameters
傳回
Promise<Favorite>
createFavoriteOfOwner(FavoriteCreateParameters, string, string)
function createFavoriteOfOwner(favorite: FavoriteCreateParameters, ownerScopeType: string, ownerScopeId: string): Promise<Favorite>參數
- favorite
- FavoriteCreateParameters
- 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[]>