WikiRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's
- Uitbreiding
Constructors
| Wiki |
Eigenschappen
| RESOURCE_AREA_ID |
Methoden
| add |
Voeg een opmerking toe op een wikipagina. |
| add |
Voeg een reactie toe aan een opmerking op een wikipagina. |
| create |
Uploadt een bijlage op een opmerking op een wikipagina. |
| create |
Hiermee maakt u een nieuwe resource voor paginaweergavestatistieken of werkt u een bestaande resource voor paginaweergavestatistieken bij. |
| create |
Hiermee maakt u de wikiresource. |
| delete |
Een opmerking op een wikipagina verwijderen. |
| delete |
Een reactie verwijderen op een opmerking op een wikipagina. |
| delete |
Hiermee verwijdert u de wiki die overeenkomt met de opgegeven wiki-id of wikinaam. |
| get |
Hiermee haalt u alle wiki's in een project of verzameling op. |
| get |
Hiermee downloadt u een bijlage op een opmerking op een wikipagina. |
| get |
Retourneert een opmerking die is gekoppeld aan de wikipagina. |
| get |
Hiermee wordt een lijst opgehaald met gebruikers die hebben gereageerd op de opgegeven wiki-opmerking met een bepaald reactietype. Ondersteunt paging, met een standaardpaginaformaat van 100 gebruikers tegelijk. |
| get |
Krijgt metadata of inhoud van de wiki-pagina voor het gegeven pagina-id. Inhoudsonderhandeling wordt uitgevoerd op basis van de |
| get |
Krijgt metadata of inhoud van de wiki-pagina voor het gegeven pagina-id. Inhoudsonderhandeling wordt uitgevoerd op basis van de |
| get |
Retourneert paginadetails die overeenkomen met pagina-id. |
| get |
Krijgt de lijst met paginapaden voor alle pagina's in de gespecificeerde wiki-versie. |
| get |
Hiermee wordt een paginabare lijst met wikipagina's geretourneerd |
| get |
Hiermee haalt u metagegevens of inhoud van de wikipagina voor het opgegeven pad op. De inhoudsonderhandeling wordt gedaan op basis van de |
| get |
Hiermee haalt u metagegevens of inhoud van de wikipagina voor het opgegeven pad op. De inhoudsonderhandeling wordt gedaan op basis van de |
| get |
Hiermee haalt u de wiki op die overeenkomt met de opgegeven wiki-id of wikinaam. |
| list |
Retourneert een paginabare lijst met opmerkingen. |
| update |
Werk een opmerking bij op een wikipagina. |
| update |
Hiermee werkt u de wiki bij die overeenkomt met de wiki-id of wikinaam die is opgegeven met behulp van de updateparameters. |
Constructordetails
WikiRestClient(IVssRestClientOptions)
Eigenschapdetails
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: "bf7d82a0-8aa5-4613-94ef-6172a5ea01f3" = "bf7d82a0-8aa5-4613-94ef-6172a5ea01f3"Waarde van eigenschap
"bf7d82a0-8aa5-4613-94ef-6172a5ea01f3"
Methodedetails
addComment(CommentCreateParameters, string, string, number)
Voeg een opmerking toe op een wikipagina.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parameters
- request
- CommentCreateParameters
Aanvraag voor het maken van opmerkingen.
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
Retouren
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Voeg een reactie toe aan een opmerking op een wikipagina.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam
- pageId
-
number
Wikipagina-id
- commentId
-
number
Id van de gekoppelde opmerking
- type
- CommentReactionType
Het type reactie dat wordt toegevoegd
Retouren
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Uploadt een bijlage op een opmerking op een wikipagina.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parameters
- content
-
any
Te uploaden inhoud
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
Retouren
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Hiermee maakt u een nieuwe resource voor paginaweergavestatistieken of werkt u een bestaande resource voor paginaweergavestatistieken bij.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- wikiVersion
- GitVersionDescriptor
Wikiversie.
- path
-
string
Wikipaginapad.
- oldPath
-
string
Oud paginapad. Dit is optioneel en vereist om het pad in bestaande paginaweergavestatistieken te wijzigen.
Retouren
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Hiermee maakt u de wikiresource.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parameters
- wikiCreateParams
- WikiCreateParametersV2
Parameters voor het maken van de wiki.
- project
-
string
Project-id of projectnaam
Retouren
Promise<WikiV2>
deleteComment(string, string, number, number)
Een opmerking op een wikipagina verwijderen.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of -naam.
- pageId
-
number
Wikipagina-id.
- id
-
number
Opmerking-id.
Retouren
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Een reactie verwijderen op een opmerking op een wikipagina.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of -naam
- pageId
-
number
Wikipagina-id
- commentId
-
number
Id van de gekoppelde opmerking
- type
- CommentReactionType
Type reactie dat wordt verwijderd
Retouren
Promise<CommentReaction>
deleteWiki(string, string)
Hiermee verwijdert u de wiki die overeenkomt met de opgegeven wiki-id of wikinaam.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parameters
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- project
-
string
Project-id of projectnaam
Retouren
Promise<WikiV2>
getAllWikis(string)
Hiermee haalt u alle wiki's in een project of verzameling op.
function getAllWikis(project?: string): Promise<WikiV2[]>Parameters
- project
-
string
Project-id of projectnaam
Retouren
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Hiermee downloadt u een bijlage op een opmerking op een wikipagina.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- attachmentId
-
string
Bijlage-id.
Retouren
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Retourneert een opmerking die is gekoppeld aan de wikipagina.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- id
-
number
Id van de opmerking die moet worden geretourneerd.
- excludeDeleted
-
boolean
Geef op of de verwijderde opmerking moet worden overgeslagen.
- expand
- CommentExpandOptions
Hiermee geeft u de extra opties voor het ophalen van gegevens voor opmerkingen.
Retouren
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Hiermee wordt een lijst opgehaald met gebruikers die hebben gereageerd op de opgegeven wiki-opmerking met een bepaald reactietype. Ondersteunt paging, met een standaardpaginaformaat van 100 gebruikers tegelijk.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- commentId
-
number
Id van de gekoppelde opmerking
- type
- CommentReactionType
Type reactie waarvoor de betrokken gebruikers worden aangevraagd
- top
-
number
Het aantal gebruikers dat moet worden geretourneerd op een bepaalde pagina. Optioneel, standaard ingesteld op 100
- skip
-
number
Aantal betrokken gebruikers dat moet worden overgeslagen op pagina de volgende set betrokken gebruikers, standaard ingesteld op 0
Retouren
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Krijgt metadata of inhoud van de wiki-pagina voor het gegeven pagina-id. Inhoudsonderhandeling wordt uitgevoerd op basis van de Accept header die in het verzoek wordt verzonden.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam..
- id
-
number
Wikipagina-id.
- recursionLevel
- VersionControlRecursionType
Recursieniveau voor het ophalen van subpagina's. Standaard is None (optioneel).
- includeContent
-
boolean
Waar voor het opnemen van de inhoud van de pagina in het antwoord voor het Json-inhoudstype. Standaard ingesteld op onwaar (optioneel)
Retouren
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Krijgt metadata of inhoud van de wiki-pagina voor het gegeven pagina-id. Inhoudsonderhandeling wordt uitgevoerd op basis van de Accept header die in het verzoek wordt verzonden.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam..
- id
-
number
Wikipagina-id.
- recursionLevel
- VersionControlRecursionType
Recursieniveau voor het ophalen van subpagina's. Standaard is None (optioneel).
- includeContent
-
boolean
Waar voor het opnemen van de inhoud van de pagina in het antwoord voor het Json-inhoudstype. Standaard ingesteld op onwaar (optioneel)
Retouren
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Retourneert paginadetails die overeenkomen met pagina-id.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- pageViewsForDays
-
number
laatste N dagen vanaf de huidige dag waarvoor paginaweergaven moeten worden geretourneerd. Het is inclusief de huidige dag.
Retouren
Promise<WikiPageDetail>
getPagePaths(string, string, GitVersionDescriptor)
Krijgt de lijst met paginapaden voor alle pagina's in de gespecificeerde wiki-versie.
function getPagePaths(project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<WikiPageRef[]>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor voor de wiki-branch. Standaard gebruikt hij de standaardbranch voor ProjectWiki. Vereist voor CodeWiki.
Retouren
Promise<WikiPageRef[]>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Hiermee wordt een paginabare lijst met wikipagina's geretourneerd
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parameters
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki batch-paginaaanvraag.
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor voor de pagina. (Optioneel in het geval van ProjectWiki).
Retouren
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Hiermee haalt u metagegevens of inhoud van de wikipagina voor het opgegeven pad op. De inhoudsonderhandeling wordt gedaan op basis van de Accept header die in het verzoek is verzonden.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- path
-
string
Wikipaginapad.
- recursionLevel
- VersionControlRecursionType
Recursieniveau voor het ophalen van subpagina's. Standaard is None (optioneel).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor voor de pagina. Standaard ingesteld op de standaardbranch (optioneel).
- includeContent
-
boolean
Waar voor het opnemen van de inhoud van de pagina in het antwoord voor het Json-inhoudstype. Standaard ingesteld op onwaar (optioneel)
Retouren
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Hiermee haalt u metagegevens of inhoud van de wikipagina voor het opgegeven pad op. De inhoudsonderhandeling wordt gedaan op basis van de Accept header die in het verzoek is verzonden.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- path
-
string
Wikipaginapad.
- recursionLevel
- VersionControlRecursionType
Recursieniveau voor het ophalen van subpagina's. Standaard is None (optioneel).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor voor de pagina. Standaard ingesteld op de standaardbranch (optioneel).
- includeContent
-
boolean
Waar voor het opnemen van de inhoud van de pagina in het antwoord voor het Json-inhoudstype. Standaard ingesteld op onwaar (optioneel)
Retouren
Promise<ArrayBuffer>
getWiki(string, string)
Hiermee haalt u de wiki op die overeenkomt met de opgegeven wiki-id of wikinaam.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parameters
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- project
-
string
Project-id of projectnaam
Retouren
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Retourneert een paginabare lijst met opmerkingen.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parameters
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- top
-
number
Maximum aantal opmerkingen dat moet worden geretourneerd.
- continuationToken
-
string
Wordt gebruikt om een query uit te voeren op de volgende pagina met opmerkingen.
- excludeDeleted
-
boolean
Geef op of de verwijderde opmerkingen moeten worden overgeslagen.
- expand
- CommentExpandOptions
Hiermee geeft u de extra opties voor het ophalen van gegevens voor opmerkingen.
- order
- CommentSortOrder
Volgorde waarin de opmerkingen moeten worden geretourneerd.
- parentId
-
number
CommentId van de bovenliggende opmerking.
Retouren
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Werk een opmerking bij op een wikipagina.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parameters
- comment
- CommentUpdateParameters
Aanvraag voor bijwerken van opmerkingen.
- project
-
string
Project-id of projectnaam
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- pageId
-
number
Wikipagina-id.
- id
-
number
Opmerking-id.
Retouren
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Hiermee werkt u de wiki bij die overeenkomt met de wiki-id of wikinaam die is opgegeven met behulp van de updateparameters.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parameters
- updateParameters
- WikiUpdateParameters
Parameters bijwerken.
- wikiIdentifier
-
string
Wiki-id of wikinaam.
- project
-
string
Project-id of projectnaam
Retouren
Promise<WikiV2>