FavoriteRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- 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[]>