FavoriteRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- Extends
Constructeurs
| Favorite |
Méthodes
Détails du constructeur
FavoriteRestClient(IVssRestClientOptions)
Détails de la méthode
createFavorite(FavoriteCreateParameters)
function createFavorite(favorite: FavoriteCreateParameters): Promise<Favorite>Paramètres
- favorite
- FavoriteCreateParameters
Retours
Promise<Favorite>
createFavoriteOfOwner(FavoriteCreateParameters, string, string)
function createFavoriteOfOwner(favorite: FavoriteCreateParameters, ownerScopeType: string, ownerScopeId: string): Promise<Favorite>Paramètres
- favorite
- FavoriteCreateParameters
- ownerScopeType
-
string
- ownerScopeId
-
string
Retours
Promise<Favorite>
deleteFavoriteById(string, string, string, string)
function deleteFavoriteById(favoriteId: string, artifactType: string, artifactScopeType: string, artifactScopeId?: string): Promise<void>Paramètres
- favoriteId
-
string
- artifactType
-
string
- artifactScopeType
-
string
- artifactScopeId
-
string
Retours
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>Paramètres
- favoriteId
-
string
- ownerScopeType
-
string
- ownerScopeId
-
string
- artifactType
-
string
- artifactScopeType
-
string
- artifactScopeId
-
string
Retours
Promise<void>
getFavoriteByArtifact(string, string, string, string, boolean)
function getFavoriteByArtifact(artifactType: string, artifactId: string, artifactScopeType: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite>Paramètres
- artifactType
-
string
- artifactId
-
string
- artifactScopeType
-
string
- artifactScopeId
-
string
- includeExtendedDetails
-
boolean
Retours
Promise<Favorite>
getFavoriteById(string, string, string, string, boolean)
function getFavoriteById(favoriteId: string, artifactScopeType: string, artifactType: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite>Paramètres
- favoriteId
-
string
- artifactScopeType
-
string
- artifactType
-
string
- artifactScopeId
-
string
- includeExtendedDetails
-
boolean
Retours
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>Paramètres
- favoriteId
-
string
- ownerScopeType
-
string
- ownerScopeId
-
string
- artifactScopeType
-
string
- artifactType
-
string
- artifactScopeId
-
string
- includeExtendedDetails
-
boolean
Retours
Promise<Favorite>
getFavoriteProviders(boolean)
function getFavoriteProviders(faultInMissingHost?: boolean): Promise<FavoriteProvider[]>Paramètres
- faultInMissingHost
-
boolean
Retours
Promise<FavoriteProvider[]>
getFavorites(string, string, string, boolean)
function getFavorites(artifactType?: string, artifactScopeType?: string, artifactScopeId?: string, includeExtendedDetails?: boolean): Promise<Favorite[]>Paramètres
- artifactType
-
string
- artifactScopeType
-
string
- artifactScopeId
-
string
- includeExtendedDetails
-
boolean
Retours
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[]>Paramètres
- ownerScopeType
-
string
- ownerScopeId
-
string
- artifactType
-
string
- artifactScopeType
-
string
- artifactScopeId
-
string
- includeExtendedDetails
-
boolean
Retours
Promise<Favorite[]>