WikiRestClient class
Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er
- Extends
Konstruktorer
| Wiki |
Egenskaper
| RESOURCE_AREA_ID |
Metoder
| add |
Lägg till en kommentar på en wiki-sida. |
| add |
Lägg till en reaktion på en wiki-sidkommentare. |
| create |
Laddar upp en bifogad fil på en kommentar på en wiki-sida. |
| create |
Skapar en ny sidvisningsstatistikresurs eller uppdaterar en befintlig sidvisningsstatistikresurs. |
| create |
Skapar wiki-resursen. |
| delete |
Ta bort en kommentar på en wiki-sida. |
| delete |
Ta bort en reaktion på en wiki-sidkommentare. |
| delete |
Tar bort wikin som motsvarar det wiki-ID eller wiki-namn som angetts. |
| get |
Hämtar alla wikis i ett projekt eller en samling. |
| get |
Laddar ned en bifogad fil på en kommentar på en wiki-sida. |
| get |
Returnerar en kommentar som är associerad med Wiki-sidan. |
| get |
Hämtar en lista över användare som har reagerat för den aktuella wiki-kommentaren med en viss reaktionstyp. Stöder sidindelning med en standardstorlek på 100 användare åt gången. |
| get |
Hämtar metadata eller innehåll på wiki-sidan för det angivna sid-ID:t. Innehållsförhandlingen görs baserat på |
| get |
Hämtar metadata eller innehåll på wiki-sidan för det angivna sid-ID:t. Innehållsförhandlingen görs baserat på |
| get |
Returnerar sidinformation som motsvarar sid-ID. |
| get |
Returnerar växlingsbar lista över Wiki-sidor |
| get |
Hämtar metadata eller innehåll på wiki-sidan för den angivna sökvägen. Innehållsförhandlingen görs baserat på |
| get |
Hämtar metadata eller innehåll på wiki-sidan för den angivna sökvägen. Innehållsförhandlingen görs baserat på |
| get |
Hämtar wikin som motsvarar wiki-ID:t eller wiki-namnet. |
| list |
Returnerar en växlingsbar lista med kommentarer. |
| update |
Uppdatera en kommentar på en wiki-sida. |
| update |
Uppdaterar wikin som motsvarar wiki-ID:t eller wiki-namnet som tillhandahålls med hjälp av uppdateringsparametrarna. |
Konstruktorinformation
WikiRestClient(IVssRestClientOptions)
Egenskapsinformation
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEgenskapsvärde
string
Metodinformation
addComment(CommentCreateParameters, string, string, number)
Lägg till en kommentar på en wiki-sida.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parametrar
- request
- CommentCreateParameters
Begäran om att skapa kommentarer.
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
Returer
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Lägg till en reaktion på en wiki-sidkommentare.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wiki-namn
- pageId
-
number
Wiki-sid-ID
- commentId
-
number
ID för den associerade kommentaren
- type
- CommentReactionType
Typ av reaktion som läggs till
Returer
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Laddar upp en bifogad fil på en kommentar på en wiki-sida.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parametrar
- content
-
any
Innehåll som ska laddas upp
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
Returer
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Skapar en ny sidvisningsstatistikresurs eller uppdaterar en befintlig sidvisningsstatistikresurs.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- wikiVersion
- GitVersionDescriptor
Wiki-version.
- path
-
string
Wiki-sidsökväg.
- oldPath
-
string
Gammal sidsökväg. Detta är valfritt och krävs för att byta namn på sökvägen i befintlig sidvisningsstatistik.
Returer
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Skapar wiki-resursen.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parametrar
- wikiCreateParams
- WikiCreateParametersV2
Parametrar för wiki-skapandet.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<WikiV2>
deleteComment(string, string, number, number)
Ta bort en kommentar på en wiki-sida.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller namn.
- pageId
-
number
Wiki-sid-ID.
- id
-
number
Kommentars-ID.
Returer
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Ta bort en reaktion på en wiki-sidkommentare.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller namn
- pageId
-
number
Wiki-sid-ID
- commentId
-
number
ID för den associerade kommentaren
- type
- CommentReactionType
Typ av reaktion som tas bort
Returer
Promise<CommentReaction>
deleteWiki(string, string)
Tar bort wikin som motsvarar det wiki-ID eller wiki-namn som angetts.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametrar
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<WikiV2>
getAllWikis(string)
Hämtar alla wikis i ett projekt eller en samling.
function getAllWikis(project?: string): Promise<WikiV2[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Laddar ned en bifogad fil på en kommentar på en wiki-sida.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- attachmentId
-
string
ID för bifogade filer.
Returer
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Returnerar en kommentar som är associerad med Wiki-sidan.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- id
-
number
ID för kommentaren som ska returneras.
- excludeDeleted
-
boolean
Ange om den borttagna kommentaren ska hoppas över.
- expand
- CommentExpandOptions
Anger de ytterligare alternativen för datahämtning för kommentarer.
Returer
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Hämtar en lista över användare som har reagerat för den aktuella wiki-kommentaren med en viss reaktionstyp. Stöder sidindelning med en standardstorlek på 100 användare åt gången.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- commentId
-
number
ID för den associerade kommentaren
- type
- CommentReactionType
Typ av reaktion som de engagerade användarna begärs för
- top
-
number
Antal motkopplade användare som ska returneras på en viss sida. Valfritt, standardvärdet är 100
- skip
-
number
Antal engagerade användare som ska hoppas över för att sida nästa uppsättning engagerade användare, standardvärdet är 0
Returer
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Hämtar metadata eller innehåll på wiki-sidan för det angivna sid-ID:t. Innehållsförhandlingen görs baserat på Accept-huvudet som skickas i begäran.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn..
- id
-
number
Wiki-sid-ID.
- recursionLevel
- VersionControlRecursionType
Rekursionsnivå för hämtning av undersidor. Standardvärdet är None (valfritt).
- includeContent
-
boolean
Sant att inkludera innehållet på sidan i svaret för Json-innehållstypen. Standardvärdet är false (valfritt)
Returer
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Hämtar metadata eller innehåll på wiki-sidan för det angivna sid-ID:t. Innehållsförhandlingen görs baserat på Accept-huvudet som skickas i begäran.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn..
- id
-
number
Wiki-sid-ID.
- recursionLevel
- VersionControlRecursionType
Rekursionsnivå för hämtning av undersidor. Standardvärdet är None (valfritt).
- includeContent
-
boolean
Sant att inkludera innehållet på sidan i svaret för Json-innehållstypen. Standardvärdet är false (valfritt)
Returer
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Returnerar sidinformation som motsvarar sid-ID.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- pageViewsForDays
-
number
senaste N dagarna från den aktuella dagen för vilken sidvisningar ska returneras. Det är inkluderande för dagens datum.
Returer
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Returnerar växlingsbar lista över Wiki-sidor
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parametrar
- pagesBatchRequest
- WikiPagesBatchRequest
Begäran om wiki-batchsida.
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor för sidan. (Valfritt för ProjectWiki).
Returer
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Hämtar metadata eller innehåll på wiki-sidan för den angivna sökvägen. Innehållsförhandlingen görs baserat på Accept-huvudet som skickas i begäran.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- path
-
string
Wiki-sidsökväg.
- recursionLevel
- VersionControlRecursionType
Rekursionsnivå för hämtning av undersidor. Standardvärdet är None (valfritt).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor för sidan. Standardvärdet är standardgrenen (valfritt).
- includeContent
-
boolean
Sant att inkludera innehållet på sidan i svaret för Json-innehållstypen. Standardvärdet är false (valfritt)
Returer
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Hämtar metadata eller innehåll på wiki-sidan för den angivna sökvägen. Innehållsförhandlingen görs baserat på Accept-huvudet som skickas i begäran.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- path
-
string
Wiki-sidsökväg.
- recursionLevel
- VersionControlRecursionType
Rekursionsnivå för hämtning av undersidor. Standardvärdet är None (valfritt).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor för sidan. Standardvärdet är standardgrenen (valfritt).
- includeContent
-
boolean
Sant att inkludera innehållet på sidan i svaret för Json-innehållstypen. Standardvärdet är false (valfritt)
Returer
Promise<ArrayBuffer>
getWiki(string, string)
Hämtar wikin som motsvarar wiki-ID:t eller wiki-namnet.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametrar
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Returnerar en växlingsbar lista med kommentarer.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- top
-
number
Maximalt antal kommentarer som ska returneras.
- continuationToken
-
string
Används för att fråga efter nästa sida med kommentarer.
- excludeDeleted
-
boolean
Ange om de borttagna kommentarerna ska hoppas över.
- expand
- CommentExpandOptions
Anger de ytterligare alternativen för datahämtning för kommentarer.
- order
- CommentSortOrder
I vilken ordning kommentarerna ska returneras.
- parentId
-
number
CommentId för den överordnade kommentaren.
Returer
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Uppdatera en kommentar på en wiki-sida.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parametrar
- comment
- CommentUpdateParameters
Begäran om kommentarsuppdatering.
- project
-
string
Projekt-ID eller projektnamn
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- pageId
-
number
Wiki-sid-ID.
- id
-
number
Kommentars-ID.
Returer
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Uppdaterar wikin som motsvarar wiki-ID:t eller wiki-namnet som tillhandahålls med hjälp av uppdateringsparametrarna.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parametrar
- updateParameters
- WikiUpdateParameters
Uppdatera parametrar.
- wikiIdentifier
-
string
Wiki-ID eller wikinamn.
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<WikiV2>