مشاركة عبر


FavoriteRestClient class

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

المنشئون

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