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[]>
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈