WikiRestClient class
Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS
- Extends
Konstruktory
| Wiki |
Vlastnosti
| RESOURCE_AREA_ID |
Metody
| add |
Přidejte komentář na stránku wikiwebu. |
| add |
Přidejte reakci na komentář na stránce wikiwebu. |
| create |
Nahraje přílohu na komentář na stránku wikiwebu. |
| create |
Vytvoří nový prostředek statistiky zobrazení stránky nebo aktualizuje existující prostředek statistik zobrazení stránky. |
| create |
Vytvoří prostředek wikiwebu. |
| delete |
Odstranění komentáře na stránce wikiwebu |
| delete |
Odstranění reakce v komentáři na stránce wikiwebu |
| delete |
Odstraní wikiweb odpovídající zadanému ID wikiwebu nebo názvu wikiwebu. |
| get |
Získá všechny wikiweby v projektu nebo kolekci. |
| get |
Stáhne přílohu s komentářem na stránce wikiwebu. |
| get |
Vrátí komentář přidružený ke stránce wikiwebu. |
| get |
Získá seznam uživatelů, kteří reagovali na daný komentář wikiwebu s daným typem reakce. Podporuje stránkování s výchozí velikostí stránky 100 uživatelů najednou. |
| get |
Získá metadata nebo obsah stránky wikiwebu pro zadané ID stránky. Vyjednávání obsahu se provádí na základě hlavičky |
| get |
Získá metadata nebo obsah stránky wikiwebu pro zadané ID stránky. Vyjednávání obsahu se provádí na základě hlavičky |
| get |
Vrátí podrobnosti stránky odpovídající ID stránky. |
| get |
Vrátí stránkovatelný seznam stránek wikiwebu. |
| get |
Získá metadata nebo obsah stránky wikiwebu pro zadanou cestu. Vyjednávání obsahu se provádí na základě hlavičky |
| get |
Získá metadata nebo obsah stránky wikiwebu pro zadanou cestu. Vyjednávání obsahu se provádí na základě hlavičky |
| get |
Získá wikiweb odpovídající wiki ID nebo wiki název zadaný. |
| list |
Vrátí stránkovatelný seznam komentářů. |
| update |
Aktualizace komentáře na stránce wikiwebu |
| update |
Aktualizace wikiwebu, který odpovídá ID wikiwebu nebo názvu wikiwebu zadanému pomocí parametrů aktualizace. |
Podrobnosti konstruktoru
WikiRestClient(IVssRestClientOptions)
Podrobnosti vlastnosti
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringHodnota vlastnosti
string
Podrobnosti metody
addComment(CommentCreateParameters, string, string, number)
Přidejte komentář na stránku wikiwebu.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parametry
- request
- CommentCreateParameters
Žádost o vytvoření komentáře
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
Návraty
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Přidejte reakci na komentář na stránce wikiwebu.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu
- pageId
-
number
ID stránky wikiwebu
- commentId
-
number
ID přidruženého komentáře
- type
- CommentReactionType
Typ přidávané reakce
Návraty
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Nahraje přílohu na komentář na stránku wikiwebu.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parametry
- content
-
any
Obsah k nahrání
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
Návraty
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Vytvoří nový prostředek statistiky zobrazení stránky nebo aktualizuje existující prostředek statistik zobrazení stránky.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- wikiVersion
- GitVersionDescriptor
Verze wikiwebu.
- path
-
string
Cesta stránky wikiwebu.
- oldPath
-
string
Stará cesta stránky. Tato možnost je volitelná a vyžaduje se k přejmenování cesty v existujících statistikách zobrazení stránky.
Návraty
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Vytvoří prostředek wikiwebu.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parametry
- wikiCreateParams
- WikiCreateParametersV2
Parametry pro vytvoření wikiwebu
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<WikiV2>
deleteComment(string, string, number, number)
Odstranění komentáře na stránce wikiwebu
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- id
-
number
ID komentáře.
Návraty
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Odstranění reakce v komentáři na stránce wikiwebu
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID nebo název wikiwebu
- pageId
-
number
ID stránky wikiwebu
- commentId
-
number
ID přidruženého komentáře
- type
- CommentReactionType
Typ odstraněné reakce
Návraty
Promise<CommentReaction>
deleteWiki(string, string)
Odstraní wikiweb odpovídající zadanému ID wikiwebu nebo názvu wikiwebu.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametry
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<WikiV2>
getAllWikis(string)
Získá všechny wikiweby v projektu nebo kolekci.
function getAllWikis(project?: string): Promise<WikiV2[]>Parametry
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Stáhne přílohu s komentářem na stránce wikiwebu.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- attachmentId
-
string
ID přílohy.
Návraty
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Vrátí komentář přidružený ke stránce wikiwebu.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- id
-
number
ID komentáře, který se má vrátit.
- excludeDeleted
-
boolean
Určete, jestli se má odstraněný komentář přeskočit.
- expand
- CommentExpandOptions
Určuje další možnosti načítání dat pro komentáře.
Návraty
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Získá seznam uživatelů, kteří reagovali na daný komentář wikiwebu s daným typem reakce. Podporuje stránkování s výchozí velikostí stránky 100 uživatelů najednou.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- commentId
-
number
ID přidruženého komentáře
- type
- CommentReactionType
Typ reakce, pro kterou jsou zapojení uživatelé požadováni
- top
-
number
Počet přihlášených uživatelů, kteří se mají vrátit na danou stránku. Volitelné, výchozí hodnota je 100
- skip
-
number
Počet aktivních uživatelů, kteří se mají přeskočit na stránku další sady aktivních uživatelů, výchozí hodnota je 0
Návraty
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Získá metadata nebo obsah stránky wikiwebu pro zadané ID stránky. Vyjednávání obsahu se provádí na základě hlavičky Accept odeslané v požadavku.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- id
-
number
ID stránky wikiwebu.
- recursionLevel
- VersionControlRecursionType
Úroveň rekurze pro načítání podstránek. Výchozí hodnota je None (Volitelné).
- includeContent
-
boolean
True, pokud chcete zahrnout obsah stránky do odpovědi na typ obsahu JSON. Výchozí hodnota je false (volitelné)
Návraty
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Získá metadata nebo obsah stránky wikiwebu pro zadané ID stránky. Vyjednávání obsahu se provádí na základě hlavičky Accept odeslané v požadavku.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- id
-
number
ID stránky wikiwebu.
- recursionLevel
- VersionControlRecursionType
Úroveň rekurze pro načítání podstránek. Výchozí hodnota je None (Volitelné).
- includeContent
-
boolean
True, pokud chcete zahrnout obsah stránky do odpovědi na typ obsahu JSON. Výchozí hodnota je false (volitelné)
Návraty
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Vrátí podrobnosti stránky odpovídající ID stránky.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- pageViewsForDays
-
number
posledních N dnů od aktuálního dne, pro které se mají vrátit zobrazení stránek. Je to včetně aktuálního dne.
Návraty
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Vrátí stránkovatelný seznam stránek wikiwebu.
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parametry
- pagesBatchRequest
- WikiPagesBatchRequest
Žádost o dávkovou stránku wikiwebu
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pro stránku. (Volitelné v případě ProjectWiki).
Návraty
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Získá metadata nebo obsah stránky wikiwebu pro zadanou cestu. Vyjednávání obsahu se provádí na základě hlavičky Accept odeslané v požadavku.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- path
-
string
Cesta stránky wikiwebu.
- recursionLevel
- VersionControlRecursionType
Úroveň rekurze pro načítání podstránek. Výchozí hodnota je None (Volitelné).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pro stránku. Výchozí hodnota je výchozí větev (volitelné).
- includeContent
-
boolean
True, pokud chcete zahrnout obsah stránky do odpovědi na typ obsahu JSON. Výchozí hodnota je false (volitelné)
Návraty
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Získá metadata nebo obsah stránky wikiwebu pro zadanou cestu. Vyjednávání obsahu se provádí na základě hlavičky Accept odeslané v požadavku.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- path
-
string
Cesta stránky wikiwebu.
- recursionLevel
- VersionControlRecursionType
Úroveň rekurze pro načítání podstránek. Výchozí hodnota je None (Volitelné).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pro stránku. Výchozí hodnota je výchozí větev (volitelné).
- includeContent
-
boolean
True, pokud chcete zahrnout obsah stránky do odpovědi na typ obsahu JSON. Výchozí hodnota je false (volitelné)
Návraty
Promise<ArrayBuffer>
getWiki(string, string)
Získá wikiweb odpovídající wiki ID nebo wiki název zadaný.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametry
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Vrátí stránkovatelný seznam komentářů.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parametry
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- top
-
number
Maximální počet komentářů, které se mají vrátit.
- continuationToken
-
string
Používá se k dotazování na další stránku komentářů.
- excludeDeleted
-
boolean
Určete, jestli se mají odstraněné komentáře přeskočit.
- expand
- CommentExpandOptions
Určuje další možnosti načítání dat pro komentáře.
- order
- CommentSortOrder
Pořadí, ve kterém se mají komentáře vracet.
- parentId
-
number
CommentId nadřazeného komentáře.
Návraty
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Aktualizace komentáře na stránce wikiwebu
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parametry
- comment
- CommentUpdateParameters
Žádost o aktualizaci komentáře
- project
-
string
ID projektu nebo název projektu
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- pageId
-
number
ID stránky wikiwebu.
- id
-
number
ID komentáře.
Návraty
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Aktualizace wikiwebu, který odpovídá ID wikiwebu nebo názvu wikiwebu zadanému pomocí parametrů aktualizace.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parametry
- updateParameters
- WikiUpdateParameters
Aktualizujte parametry.
- wikiIdentifier
-
string
ID wikiwebu nebo název wikiwebu.
- project
-
string
ID projektu nebo název projektu
Návraty
Promise<WikiV2>