WikiRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Wiki |
Tulajdonságok
| RESOURCE_AREA_ID |
Metódusok
| add |
Megjegyzés hozzáadása wikilaphoz. |
| add |
Adjon hozzá egy reakciót egy wikioldal megjegyzéséhez. |
| create |
Mellékletet tölt fel egy wikilapon lévő megjegyzéshez. |
| create |
Új oldalmegtekintési statisztika erőforrást hoz létre, vagy frissít egy meglévő oldalmegtekintési statisztika erőforrást. |
| create |
Létrehozza a wiki-erőforrást. |
| delete |
Wikilapon lévő megjegyzés törlése. |
| delete |
Reakció törlése egy wikioldal megjegyzésére. |
| delete |
Törli a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit. |
| get |
Lekéri a projekt vagy gyűjtemény összes wikijét. |
| get |
Letölt egy wikilapon lévő megjegyzés mellékletét. |
| get |
A wikioldalhoz társított megjegyzést ad vissza. |
| get |
Lekéri azoknak a felhasználóknak a listáját, akik reagáltak az adott wiki megjegyzésre egy adott reakciótípussal. Támogatja a lapozást, az alapértelmezett oldalméret egyszerre 100 felhasználó. |
| get |
Lekéri a wikioldal metaadatait vagy tartalmát a megadott oldalazonosítóhoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján |
| get |
Lekéri a wikioldal metaadatait vagy tartalmát a megadott oldalazonosítóhoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján |
| get |
Az oldalazonosítónak megfelelő oldaladatokat adja vissza. |
| get |
Visszaadja a wikilapok lapozható listáját |
| get |
Lekéri a wikioldal metaadatait vagy tartalmát a megadott elérési úthoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján |
| get |
Lekéri a wikioldal metaadatait vagy tartalmát a megadott elérési úthoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján |
| get |
Lekéri a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit. |
| list |
A megjegyzések lapozható listáját adja vissza. |
| update |
Wikilapon lévő megjegyzés frissítése. |
| update |
Frissíti a frissítési paraméterekkel megadott wikiazonosítónak vagy wikinévnek megfelelő wikit. |
Konstruktor adatai
WikiRestClient(IVssRestClientOptions)
Tulajdonság adatai
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringTulajdonság értéke
string
Metódus adatai
addComment(CommentCreateParameters, string, string, number)
Megjegyzés hozzáadása wikilaphoz.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Paraméterek
- request
- CommentCreateParameters
Megjegyzés létrehozása kérés.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
Válaszok
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Adjon hozzá egy reakciót egy wikioldal megjegyzéséhez.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy wikinév
- pageId
-
number
Wiki oldal azonosítója
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
A hozzáadandó reakció típusa
Válaszok
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Mellékletet tölt fel egy wikilapon lévő megjegyzéshez.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Paraméterek
- content
-
any
Feltöltendő tartalom
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
Válaszok
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Új oldalmegtekintési statisztika erőforrást hoz létre, vagy frissít egy meglévő oldalmegtekintési statisztika erőforrást.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- wikiVersion
- GitVersionDescriptor
Wiki verzió.
- path
-
string
Wiki oldal elérési útja.
- oldPath
-
string
Régi oldal elérési útja. Ez nem kötelező, és szükséges az elérési út átnevezéséhez a meglévő oldalmegtekintési statisztikákban.
Válaszok
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Létrehozza a wiki-erőforrást.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Paraméterek
- wikiCreateParams
- WikiCreateParametersV2
A wiki létrehozásának paraméterei.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>
deleteComment(string, string, number, number)
Wikilapon lévő megjegyzés törlése.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy név.
- pageId
-
number
Wiki oldal azonosítója.
- id
-
number
Megjegyzés azonosítója.
Válaszok
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Reakció törlése egy wikioldal megjegyzésére.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy név
- pageId
-
number
Wiki oldal azonosítója
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
A törölendő reakció típusa
Válaszok
Promise<CommentReaction>
deleteWiki(string, string)
Törli a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Paraméterek
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>
getAllWikis(string)
Lekéri a projekt vagy gyűjtemény összes wikijét.
function getAllWikis(project?: string): Promise<WikiV2[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Letölt egy wikilapon lévő megjegyzés mellékletét.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- attachmentId
-
string
Melléklet azonosítója.
Válaszok
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
A wikioldalhoz társított megjegyzést ad vissza.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- id
-
number
A visszaadni kívánt megjegyzés azonosítója.
- excludeDeleted
-
boolean
Adja meg, hogy a törölt megjegyzést ki kell-e hagyni.
- expand
- CommentExpandOptions
Megadja a megjegyzések további adatbeolvasási beállításait.
Válaszok
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Lekéri azoknak a felhasználóknak a listáját, akik reagáltak az adott wiki megjegyzésre egy adott reakciótípussal. Támogatja a lapozást, az alapértelmezett oldalméret egyszerre 100 felhasználó.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
A reakció típusa, amelyre a megbízott felhasználókat kérik
- top
-
number
Az adott oldalon visszaadandó megnövelt felhasználók száma. Nem kötelező, alapértelmezés szerint 100
- skip
-
number
Azon elkötelezett felhasználók száma, akiket át kell ugrani az elkötelezett felhasználók következő csoportjára, alapértelmezés szerint 0
Válaszok
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Lekéri a wikioldal metaadatait vagy tartalmát a megadott oldalazonosítóhoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján Accept történik.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- id
-
number
Wiki oldal azonosítója.
- recursionLevel
- VersionControlRecursionType
Rekurziós szint az allapok visszakereséséhez. Alapértelmezett értéke None (nem kötelező).
- includeContent
-
boolean
Igaz, hogy az oldal tartalmát belefoglalja a Json tartalomtípusra adott válaszba. Az alapértelmezett érték hamis (nem kötelező)
Válaszok
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Lekéri a wikioldal metaadatait vagy tartalmát a megadott oldalazonosítóhoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján Accept történik.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- id
-
number
Wiki oldal azonosítója.
- recursionLevel
- VersionControlRecursionType
Rekurziós szint az allapok visszakereséséhez. Alapértelmezett értéke None (nem kötelező).
- includeContent
-
boolean
Igaz, hogy az oldal tartalmát belefoglalja a Json tartalomtípusra adott válaszba. Az alapértelmezett érték hamis (nem kötelező)
Válaszok
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Az oldalazonosítónak megfelelő oldaladatokat adja vissza.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- pageViewsForDays
-
number
az utolsó N nap attól az aktuális naptól számítva, amelyre az oldalmegtekintéseket vissza kell adni. Ez magában foglalja a jelen napot.
Válaszok
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Visszaadja a wikilapok lapozható listáját
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Paraméterek
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki kötegoldal kérése.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor az oldalhoz. (ProjectWiki esetén opcionális).
Válaszok
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Lekéri a wikioldal metaadatait vagy tartalmát a megadott elérési úthoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján Accept történik.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- path
-
string
Wiki oldal elérési útja.
- recursionLevel
- VersionControlRecursionType
Rekurziós szint az allapok visszakereséséhez. Alapértelmezett értéke None (nem kötelező).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor az oldalhoz. Alapértelmezés szerint az alapértelmezett ág (nem kötelező).
- includeContent
-
boolean
Igaz, hogy az oldal tartalmát belefoglalja a Json tartalomtípusra adott válaszba. Az alapértelmezett érték hamis (nem kötelező)
Válaszok
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Lekéri a wikioldal metaadatait vagy tartalmát a megadott elérési úthoz. A tartalomegyeztetés a kérelemben küldött fejléc alapján Accept történik.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- path
-
string
Wiki oldal elérési útja.
- recursionLevel
- VersionControlRecursionType
Rekurziós szint az allapok visszakereséséhez. Alapértelmezett értéke None (nem kötelező).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor az oldalhoz. Alapértelmezés szerint az alapértelmezett ág (nem kötelező).
- includeContent
-
boolean
Igaz, hogy az oldal tartalmát belefoglalja a Json tartalomtípusra adott válaszba. Az alapértelmezett érték hamis (nem kötelező)
Válaszok
Promise<ArrayBuffer>
getWiki(string, string)
Lekéri a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Paraméterek
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
A megjegyzések lapozható listáját adja vissza.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- top
-
number
A visszaadandó megjegyzések maximális száma.
- continuationToken
-
string
A megjegyzések következő oldalának lekérdezésére szolgál.
- excludeDeleted
-
boolean
Adja meg, hogy a törölt megjegyzéseket ki kell-e hagyni.
- expand
- CommentExpandOptions
Megadja a megjegyzések további adatbeolvasási beállításait.
- order
- CommentSortOrder
A megjegyzések visszaküldésének sorrendje.
- parentId
-
number
A szülői megjegyzés megjegyzése.
Válaszok
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Wikilapon lévő megjegyzés frissítése.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Paraméterek
- comment
- CommentUpdateParameters
Megjegyzés frissítési kérése.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- pageId
-
number
Wiki oldal azonosítója.
- id
-
number
Megjegyzés azonosítója.
Válaszok
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Frissíti a frissítési paraméterekkel megadott wikiazonosítónak vagy wikinévnek megfelelő wikit.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Paraméterek
- updateParameters
- WikiUpdateParameters
Paraméterek frissítése.
- wikiIdentifier
-
string
Wiki azonosító vagy wiki neve.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>