WikiRestClient class
Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldé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 |
Reakció hozzáadása wikioldali megjegyzéshez. |
| create |
Feltölt egy mellékletet egy wikilap megjegyzésére. |
| create |
Létrehoz egy új oldalnézet-statisztika-erőforrást, vagy frissíti a meglévő oldalnézet-statisztika-erőforrást. |
| create |
Létrehozza a wikierőforrást. |
| delete |
Megjegyzés törlése egy wikilapon. |
| delete |
Reakció törlése a wikilap megjegyzésén. |
| delete |
Törli a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit. |
| get |
Lekéri egy projekt vagy gyűjtemény összes wikijét. |
| get |
Letölt egy mellékletet egy wikilap megjegyzésére. |
| get |
A wikilaphoz 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, amelynek alapértelmezett oldalmérete egyszerre 100 felhasználó. |
| get |
Lekéri a megadott oldalazonosítóhoz tartozó wikilap metaadatait vagy tartalmát. A tartalom egyeztetése a |
| get |
Lekéri a megadott oldalazonosítóhoz tartozó wikilap metaadatait vagy tartalmát. A tartalom egyeztetése a |
| get |
Az oldalazonosítónak megfelelő laprészletet adja vissza. |
| get |
A wikilapok lapozható listáját adja vissza |
| get |
Lekéri a megadott elérési út wikilapjának metaadatait vagy tartalmát. A tartalom egyeztetése a |
| get |
Lekéri a megadott elérési út wikilapjának metaadatait vagy tartalmát. A tartalom egyeztetése a |
| get |
Lekéri a megadott wikiazonosítónak vagy wikinévnek megfelelő wikit. |
| list |
A megjegyzések lapozható listáját adja vissza. |
| update |
Megjegyzés frissítése egy wikilapon. |
| update |
Frissítések 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ási kérése.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
Válaszok
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Reakció hozzáadása wikioldali megjegyzéshez.
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
Wikilap azonosítója
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
A hozzáadott reakció típusa
Válaszok
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Feltölt egy mellékletet egy wikilap megjegyzésére.
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
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
Válaszok
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Létrehoz egy új oldalnézet-statisztika-erőforrást, vagy frissíti a meglévő oldalnézet-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
Wikiazonosító vagy wikinév.
- wikiVersion
- GitVersionDescriptor
Wikiverzió.
- path
-
string
Wikilap elérési útja.
- oldPath
-
string
Régi oldal elérési útja. Ez nem kötelező, és a meglévő oldalnézet-statisztikák elérési útjának átnevezéséhez szükséges.
Válaszok
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Létrehozza a wikierő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)
Megjegyzés törlése egy wikilapon.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy -név.
- pageId
-
number
Wikilap azonosítója.
- id
-
number
Megjegyzés azonosítója.
Válaszok
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Reakció törlése a wikilap megjegyzésén.
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
Wikilap azonosítója
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
A törölt 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
Wikiazonosító vagy wikinév.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>
getAllWikis(string)
Lekéri egy 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 mellékletet egy wikilap megjegyzésére.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- attachmentId
-
string
Melléklet azonosítója.
Válaszok
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
A wikilaphoz 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
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- id
-
number
A visszaküldött megjegyzés azonosítója.
- excludeDeleted
-
boolean
Adja meg, hogy kihagyja-e a törölt megjegyzést.
- expand
- CommentExpandOptions
Megadja a megjegyzések további adatlekéré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, amelynek alapértelmezett oldalmérete 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
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- commentId
-
number
A társított megjegyzés azonosítója
- type
- CommentReactionType
Annak a reakciónak a típusa, amelyre vonatkozóan az aktív felhasználókat kérik
- top
-
number
Az adott oldalon visszaadandó felhasználók száma. Nem kötelező, alapértelmezés szerint 100
- skip
-
number
Azon aktív felhasználók száma, amelyet át kell hagyni a következő aktív felhasználók lapjára, alapértelmezés szerint 0
Válaszok
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Lekéri a megadott oldalazonosítóhoz tartozó wikilap metaadatait vagy tartalmát. A tartalom egyeztetése a Accept kérelemben elküldött fejléc alapján 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
Wikiazonosító vagy wikinév.
- id
-
number
Wikilap azonosítója.
- recursionLevel
- VersionControlRecursionType
Mellékoldalak lekérésének rekurziós szintje. Alapértelmezés szerint a ( None nem kötelező).
- includeContent
-
boolean
Igaz, ha a Json-tartalomtípus válaszában szerepel a lap tartalma. Alapértelmezés szerint hamis (nem kötelező)
Válaszok
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Lekéri a megadott oldalazonosítóhoz tartozó wikilap metaadatait vagy tartalmát. A tartalom egyeztetése a Accept kérelemben elküldött fejléc alapján 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
Wikiazonosító vagy wikinév.
- id
-
number
Wikilap azonosítója.
- recursionLevel
- VersionControlRecursionType
Mellékoldalak lekérésének rekurziós szintje. Alapértelmezés szerint a ( None nem kötelező).
- includeContent
-
boolean
Igaz, ha a Json-tartalomtípus válaszában szerepel a lap tartalma. Alapértelmezés szerint hamis (nem kötelező)
Válaszok
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Az oldalazonosítónak megfelelő laprészletet 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
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- pageViewsForDays
-
number
utolsó N nap attól a naptól kezdve, amelyre a lapmegtekintéseket vissza szeretné adni. Ez az aktuális napot is magában foglalja.
Válaszok
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
A wikilapok lapozható listáját adja vissza
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Paraméterek
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki batch page request.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy wikinév.
- versionDescriptor
- GitVersionDescriptor
A lap GitVersionDescriptor leírója. (ProjectWiki esetén nem kötelező).
Válaszok
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Lekéri a megadott elérési út wikilapjának metaadatait vagy tartalmát. A tartalom egyeztetése a Accept kérelemben elküldött fejléc alapján 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
Wikiazonosító vagy wikinév.
- path
-
string
Wikilap elérési útja.
- recursionLevel
- VersionControlRecursionType
Mellékoldalak lekérésének rekurziós szintje. Alapértelmezés szerint a ( None nem kötelező).
- versionDescriptor
- GitVersionDescriptor
A lap GitVersionDescriptor leírója. Alapértelmezés szerint az alapértelmezett ág (nem kötelező).
- includeContent
-
boolean
Igaz, ha a Json-tartalomtípus válaszában szerepel a lap tartalma. Alapértelmezés szerint hamis (nem kötelező)
Válaszok
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Lekéri a megadott elérési út wikilapjának metaadatait vagy tartalmát. A tartalom egyeztetése a Accept kérelemben elküldött fejléc alapján 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
Wikiazonosító vagy wikinév.
- path
-
string
Wikilap elérési útja.
- recursionLevel
- VersionControlRecursionType
Mellékoldalak lekérésének rekurziós szintje. Alapértelmezés szerint a ( None nem kötelező).
- versionDescriptor
- GitVersionDescriptor
A lap GitVersionDescriptor leírója. Alapértelmezés szerint az alapértelmezett ág (nem kötelező).
- includeContent
-
boolean
Igaz, ha a Json-tartalomtípus válaszában szerepel a lap tartalma. Alapértelmezés szerint 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
Wikiazonosító vagy wikinév.
- 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
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- top
-
number
A visszaküldött 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ések kihagyhatók-e.
- expand
- CommentExpandOptions
Megadja a megjegyzések további adatlekérési beállításait.
- order
- CommentSortOrder
A megjegyzések visszaadásához szükséges sorrend.
- parentId
-
number
A szülő megjegyzés CommentId azonosítója.
Válaszok
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Megjegyzés frissítése egy wikilapon.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Paraméterek
- comment
- CommentUpdateParameters
Megjegyzésfrissítési kérelem.
- project
-
string
Projektazonosító vagy projektnév
- wikiIdentifier
-
string
Wikiazonosító vagy wikinév.
- pageId
-
number
Wikilap azonosítója.
- id
-
number
Megjegyzés azonosítója.
Válaszok
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Frissítések 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
Wikiazonosító vagy wikinév.
- project
-
string
Projektazonosító vagy projektnév
Válaszok
Promise<WikiV2>