WikiRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Wiki |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| add |
Fügen Sie einen Kommentar auf einer Wiki-Seite hinzu. |
| add |
Fügen Sie eine Reaktion auf einen Wiki-Seitenkommentar hinzu. |
| create |
Lädt eine Anlage auf einen Kommentar auf einer Wiki-Seite hoch. |
| create |
Erstellt eine neue Ressourcen zur Seitenansichtsstatistik oder aktualisiert eine vorhandene Ressourcen für Seitenansichtsstatistiken. |
| create |
Erstellt die Wiki-Ressource. |
| delete |
Löschen eines Kommentars auf einer Wiki-Seite. |
| delete |
Löschen einer Reaktion auf einem Wiki-Seitenkommentar. |
| delete |
Löscht das Wiki, das der angegebenen Wiki-ID oder dem angegebenen Wiki-Namen entspricht. |
| get |
Ruft alle Wikis in einem Projekt oder einer Auflistung ab. |
| get |
Lädt eine Anlage auf einen Kommentar auf einer Wiki-Seite herunter. |
| get |
Gibt einen Kommentar zurück, der der Wiki-Seite zugeordnet ist. |
| get |
Ruft eine Liste der Benutzer ab, die auf den angegebenen Wiki-Kommentar mit einem bestimmten Reaktionstyp reagiert haben. Unterstützt das Paging mit einer Standardseitengröße von 100 Benutzern gleichzeitig. |
| get |
Ruft Metadaten oder Inhalte der Wiki-Seite für die angegebene Seiten-ID ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten |
| get |
Ruft Metadaten oder Inhalte der Wiki-Seite für die angegebene Seiten-ID ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten |
| get |
Gibt Seitendetails zurück, die der Seiten-ID entsprechen. |
| get |
Gibt eine seitenfähige Liste von Wiki-Seiten zurück. |
| get |
Ruft Metadaten oder Inhalte der Wiki-Seite für den bereitgestellten Pfad ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten |
| get |
Ruft Metadaten oder Inhalte der Wiki-Seite für den bereitgestellten Pfad ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten |
| get |
Ruft das Wiki ab, das der angegebenen Wiki-ID oder dem angegebenen Wiki-Namen entspricht. |
| list |
Gibt eine seitenfähige Liste von Kommentaren zurück. |
| update |
Aktualisieren eines Kommentars auf einer Wiki-Seite. |
| update |
Aktualisiert das Wiki, das der Wiki-ID oder dem Wiki-Namen entspricht, die mithilfe der Updateparameter bereitgestellt werden. |
Details zum Konstruktor
WikiRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
addComment(CommentCreateParameters, string, string, number)
Fügen Sie einen Kommentar auf einer Wiki-Seite hinzu.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parameter
- request
- CommentCreateParameters
Anforderung zum Erstellen eines Kommentars.
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
Gibt zurück
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Fügen Sie eine Reaktion auf einen Wiki-Seitenkommentar hinzu.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name
- pageId
-
number
Wiki-Seiten-ID
- commentId
-
number
ID des zugeordneten Kommentars
- type
- CommentReactionType
Art der hinzugefügten Reaktion
Gibt zurück
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Lädt eine Anlage auf einen Kommentar auf einer Wiki-Seite hoch.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parameter
- content
-
any
Hochzuladende Inhalte
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
Gibt zurück
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Erstellt eine neue Ressourcen zur Seitenansichtsstatistik oder aktualisiert eine vorhandene Ressourcen für Seitenansichtsstatistiken.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- wikiVersion
- GitVersionDescriptor
Wiki-Version.
- path
-
string
Wiki-Seitenpfad.
- oldPath
-
string
Alter Seitenpfad. Dies ist optional und erforderlich, um den Pfad in vorhandenen Seitenansichtsstatistiken umzubenennen.
Gibt zurück
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Erstellt die Wiki-Ressource.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parameter
- wikiCreateParams
- WikiCreateParametersV2
Parameter für die Wiki-Erstellung.
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WikiV2>
deleteComment(string, string, number, number)
Löschen eines Kommentars auf einer Wiki-Seite.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder -Name.
- pageId
-
number
Wiki-Seiten-ID.
- id
-
number
Kommentar-ID.
Gibt zurück
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Löschen einer Reaktion auf einem Wiki-Seitenkommentar.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder -Name
- pageId
-
number
Wiki-Seiten-ID
- commentId
-
number
ID des zugeordneten Kommentars
- type
- CommentReactionType
Art der zu löschenden Reaktion
Gibt zurück
Promise<CommentReaction>
deleteWiki(string, string)
Löscht das Wiki, das der angegebenen Wiki-ID oder dem angegebenen Wiki-Namen entspricht.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parameter
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WikiV2>
getAllWikis(string)
Ruft alle Wikis in einem Projekt oder einer Auflistung ab.
function getAllWikis(project?: string): Promise<WikiV2[]>Parameter
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Lädt eine Anlage auf einen Kommentar auf einer Wiki-Seite herunter.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- attachmentId
-
string
Anlagen-ID.
Gibt zurück
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Gibt einen Kommentar zurück, der der Wiki-Seite zugeordnet ist.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- id
-
number
ID des zurückzugebenden Kommentars.
- excludeDeleted
-
boolean
Geben Sie an, ob der gelöschte Kommentar übersprungen werden soll.
- expand
- CommentExpandOptions
Gibt die zusätzlichen Datenabrufoptionen für Kommentare an.
Gibt zurück
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Ruft eine Liste der Benutzer ab, die auf den angegebenen Wiki-Kommentar mit einem bestimmten Reaktionstyp reagiert haben. Unterstützt das Paging mit einer Standardseitengröße von 100 Benutzern gleichzeitig.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- commentId
-
number
ID des zugeordneten Kommentars
- type
- CommentReactionType
Art der Reaktion, für die die engagierten Benutzer angefordert werden
- top
-
number
Die Anzahl der benutzeragageierten Benutzer, die auf einer bestimmten Seite zurückgegeben werden sollen. Optional, Standardwert 100
- skip
-
number
Die Anzahl der engagierten Benutzer, die übersprungen werden sollen, um die nächste Gruppe von engagierten Benutzern zu überspringen, ist standardmäßig auf 0 festgelegt.
Gibt zurück
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Ruft Metadaten oder Inhalte der Wiki-Seite für die angegebene Seiten-ID ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten Accept Header.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name..
- id
-
number
Wiki-Seiten-ID.
- recursionLevel
- VersionControlRecursionType
Rekursionsebene für den Abruf von Unterseiten. Standardwert ist None (optional).
- includeContent
-
boolean
True, um den Inhalt der Seite in die Antwort für json-Inhaltstyp einzuschließen. Standardwert ist "false" (Optional)
Gibt zurück
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Ruft Metadaten oder Inhalte der Wiki-Seite für die angegebene Seiten-ID ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten Accept Header.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name..
- id
-
number
Wiki-Seiten-ID.
- recursionLevel
- VersionControlRecursionType
Rekursionsebene für den Abruf von Unterseiten. Standardwert ist None (optional).
- includeContent
-
boolean
True, um den Inhalt der Seite in die Antwort für json-Inhaltstyp einzuschließen. Standardwert ist "false" (Optional)
Gibt zurück
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Gibt Seitendetails zurück, die der Seiten-ID entsprechen.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- pageViewsForDays
-
number
Letzte N Tage ab dem aktuellen Tag, für den Seitenansichten zurückgegeben werden sollen. Es ist inklusive des aktuellen Tages.
Gibt zurück
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Gibt eine seitenfähige Liste von Wiki-Seiten zurück.
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parameter
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki-Batchseitenanforderung.
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor für die Seite. (Optional im Fall von ProjectWiki).
Gibt zurück
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Ruft Metadaten oder Inhalte der Wiki-Seite für den bereitgestellten Pfad ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten Accept Header.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- path
-
string
Wiki-Seitenpfad.
- recursionLevel
- VersionControlRecursionType
Rekursionsebene für den Abruf von Unterseiten. Standardwert ist None (optional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor für die Seite. Standardmäßig wird die Standardverzweigung (Optional) verwendet.
- includeContent
-
boolean
True, um den Inhalt der Seite in die Antwort für json-Inhaltstyp einzuschließen. Standardwert ist "false" (Optional)
Gibt zurück
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Ruft Metadaten oder Inhalte der Wiki-Seite für den bereitgestellten Pfad ab. Die Inhaltsverhandlung erfolgt basierend auf dem in der Anforderung gesendeten Accept Header.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- path
-
string
Wiki-Seitenpfad.
- recursionLevel
- VersionControlRecursionType
Rekursionsebene für den Abruf von Unterseiten. Standardwert ist None (optional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor für die Seite. Standardmäßig wird die Standardverzweigung (Optional) verwendet.
- includeContent
-
boolean
True, um den Inhalt der Seite in die Antwort für json-Inhaltstyp einzuschließen. Standardwert ist "false" (Optional)
Gibt zurück
Promise<ArrayBuffer>
getWiki(string, string)
Ruft das Wiki ab, das der angegebenen Wiki-ID oder dem angegebenen Wiki-Namen entspricht.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parameter
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Gibt eine seitenfähige Liste von Kommentaren zurück.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parameter
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- top
-
number
Maximale Anzahl von Kommentaren, die zurückgegeben werden sollen.
- continuationToken
-
string
Wird verwendet, um die nächste Seite mit Kommentaren abzufragen.
- excludeDeleted
-
boolean
Geben Sie an, ob die gelöschten Kommentare übersprungen werden sollen.
- expand
- CommentExpandOptions
Gibt die zusätzlichen Datenabrufoptionen für Kommentare an.
- order
- CommentSortOrder
Reihenfolge, in der die Kommentare zurückgegeben werden sollen.
- parentId
-
number
CommentId des übergeordneten Kommentars.
Gibt zurück
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Aktualisieren eines Kommentars auf einer Wiki-Seite.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parameter
- comment
- CommentUpdateParameters
Kommentaraktualisierungsanforderung.
- project
-
string
Projekt-ID oder Projektname
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- pageId
-
number
Wiki-Seiten-ID.
- id
-
number
Kommentar-ID.
Gibt zurück
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Aktualisiert das Wiki, das der Wiki-ID oder dem Wiki-Namen entspricht, die mithilfe der Updateparameter bereitgestellt werden.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parameter
- updateParameters
- WikiUpdateParameters
Aktualisieren von Parametern.
- wikiIdentifier
-
string
Wiki-ID oder Wiki-Name.
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WikiV2>