WikiRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Wiki |
Proprietà
| RESOURCE_AREA_ID |
Metodi
| add |
Aggiungere un commento in una pagina wiki. |
| add |
Aggiungere una reazione in un commento della pagina wiki. |
| create |
Carica un allegato su un commento in una pagina wiki. |
| create |
Crea una nuova risorsa statistiche visualizzazione pagina o aggiorna una risorsa statistiche visualizzazione pagina esistente. |
| create |
Crea la risorsa wiki. |
| delete |
Eliminare un commento in una pagina wiki. |
| delete |
Eliminare una reazione in un commento della pagina wiki. |
| delete |
Elimina il wiki corrispondente all'ID wiki o al nome wiki specificato. |
| get |
Ottiene tutti i wiki in un progetto o in una raccolta. |
| get |
Scarica un allegato su un commento in una pagina wiki. |
| get |
Restituisce un commento associato alla pagina Wiki. |
| get |
Ottiene un elenco di utenti che hanno reagito per il commento wiki specificato con un determinato tipo di reazione. Supporta il paging, con dimensioni di pagina predefinite di 100 utenti alla volta. |
| get |
Ottiene i metadati o il contenuto della pagina wiki per l'ID pagina specificato. La negoziazione del contenuto viene eseguita in base all'intestazione |
| get |
Ottiene i metadati o il contenuto della pagina wiki per l'ID pagina specificato. La negoziazione del contenuto viene eseguita in base all'intestazione |
| get |
Restituisce i dettagli della pagina corrispondenti all'ID pagina. |
| get |
Restituisce un elenco di pagine wiki visualizzabili |
| get |
Ottiene i metadati o il contenuto della pagina wiki per il percorso specificato. La negoziazione del contenuto viene eseguita in base all'intestazione |
| get |
Ottiene i metadati o il contenuto della pagina wiki per il percorso specificato. La negoziazione del contenuto viene eseguita in base all'intestazione |
| get |
Ottiene il wiki corrispondente all'ID wiki o al nome wiki specificato. |
| list |
Restituisce un elenco di commenti pagable. |
| update |
Aggiornare un commento in una pagina wiki. |
| update |
Aggiornamenti il wiki corrispondente all'ID wiki o al nome wiki fornito usando i parametri di aggiornamento. |
Dettagli costruttore
WikiRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValore della proprietà
string
Dettagli metodo
addComment(CommentCreateParameters, string, string, number)
Aggiungere un commento in una pagina wiki.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parametri
- request
- CommentCreateParameters
Richiesta di creazione commenti.
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
Nome wiki o wiki.
- pageId
-
number
ID pagina Wiki.
Restituisce
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Aggiungere una reazione in un commento della pagina wiki.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametri
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
Nome wiki o wiki
- pageId
-
number
ID pagina Wiki
- commentId
-
number
ID del commento associato
- type
- CommentReactionType
Tipo della reazione aggiunta
Restituisce
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Carica un allegato su un commento in una pagina wiki.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parametri
- content
-
any
Contenuto da caricare
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
Nome wiki o wiki.
- pageId
-
number
ID pagina Wiki.
Restituisce
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Crea una nuova risorsa statistiche visualizzazione pagina o aggiorna una risorsa statistiche visualizzazione pagina esistente.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parametri
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
Nome wiki o wiki.
- wikiVersion
- GitVersionDescriptor
Versione wiki.
- path
-
string
Percorso della pagina Wiki.
- oldPath
-
string
Percorso pagina precedente. Questa opzione è facoltativa e necessaria per rinominare il percorso nelle statistiche di visualizzazione pagina esistenti.
Restituisce
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Crea la risorsa wiki.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parametri
- wikiCreateParams
- WikiCreateParametersV2
Parametri per la creazione wiki.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<WikiV2>
deleteComment(string, string, number, number)
Eliminare un commento in una pagina wiki.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parametri
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
ID wiki o nome.
- pageId
-
number
ID pagina Wiki.
- id
-
number
ID commento.
Restituisce
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Eliminare una reazione in un commento della pagina wiki.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametri
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
ID wiki o nome
- pageId
-
number
ID pagina Wiki
- commentId
-
number
ID del commento associato
- type
- CommentReactionType
Tipo della reazione eliminata
Restituisce
Promise<CommentReaction>
deleteWiki(string, string)
Elimina il wiki corrispondente all'ID wiki o al nome wiki specificato.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametri
- wikiIdentifier
-
string
Nome wiki o wiki.
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<WikiV2>
getAllWikis(string)
Ottiene tutti i wiki in un progetto o in una raccolta.
function getAllWikis(project?: string): Promise<WikiV2[]>Parametri
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Scarica un allegato su un commento in una pagina wiki.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome progetto
- wikiIdentifier
-
string
Nome wiki o wiki.
- pageId
-
number
ID pagina Wiki.
- attachmentId
-
string
ID allegato.
Restituisce
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Restituisce un commento associato alla pagina Wiki.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- pageId
-
number
ID pagina wiki.
- id
-
number
ID del commento da restituire.
- excludeDeleted
-
boolean
Specificare se il commento eliminato deve essere ignorato.
- expand
- CommentExpandOptions
Specifica le opzioni di recupero dati aggiuntive per i commenti.
Restituisce
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Ottiene un elenco di utenti che hanno reagito per il commento wiki specificato con un determinato tipo di reazione. Supporta il paging, con dimensioni di pagina predefinite di 100 utenti alla volta.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- pageId
-
number
ID pagina wiki.
- commentId
-
number
ID del commento associato
- type
- CommentReactionType
Tipo di reazione per cui vengono richiesti gli utenti coinvolti
- top
-
number
Numero di utenti ingagiati da restituire in una determinata pagina. Facoltativo, il valore predefinito è 100
- skip
-
number
Numero di utenti coinvolti da ignorare nella pagina del set successivo di utenti coinvolti, il valore predefinito è 0
Restituisce
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Ottiene i metadati o il contenuto della pagina wiki per l'ID pagina specificato. La negoziazione del contenuto viene eseguita in base all'intestazione Accept inviata nella richiesta.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki..
- id
-
number
ID pagina wiki.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione per il recupero delle pagine secondarie. Il valore predefinito è None (facoltativo).
- includeContent
-
boolean
True per includere il contenuto della pagina nella risposta per il tipo di contenuto Json. Il valore predefinito è false (facoltativo)
Restituisce
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Ottiene i metadati o il contenuto della pagina wiki per l'ID pagina specificato. La negoziazione del contenuto viene eseguita in base all'intestazione Accept inviata nella richiesta.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki..
- id
-
number
ID pagina wiki.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione per il recupero delle pagine secondarie. Il valore predefinito è None (facoltativo).
- includeContent
-
boolean
True per includere il contenuto della pagina nella risposta per il tipo di contenuto Json. Il valore predefinito è false (facoltativo)
Restituisce
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Restituisce i dettagli della pagina corrispondenti all'ID pagina.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- pageId
-
number
ID pagina wiki.
- pageViewsForDays
-
number
ultimi N giorni dal giorno corrente per cui devono essere restituite le visualizzazioni di pagina. È inclusivo del giorno corrente.
Restituisce
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Restituisce un elenco di pagine wiki visualizzabili
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parametri
- pagesBatchRequest
- WikiPagesBatchRequest
Richiesta di pagina batch wiki.
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor per la pagina. (Facoltativo nel caso di ProjectWiki).
Restituisce
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Ottiene i metadati o il contenuto della pagina wiki per il percorso specificato. La negoziazione del contenuto viene eseguita in base all'intestazione Accept inviata nella richiesta.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- path
-
string
Percorso pagina Wiki.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione per il recupero delle pagine secondarie. Il valore predefinito è None (facoltativo).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor per la pagina. Il valore predefinito è il ramo predefinito (facoltativo).
- includeContent
-
boolean
True per includere il contenuto della pagina nella risposta per il tipo di contenuto Json. Il valore predefinito è false (facoltativo)
Restituisce
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Ottiene i metadati o il contenuto della pagina wiki per il percorso specificato. La negoziazione del contenuto viene eseguita in base all'intestazione Accept inviata nella richiesta.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- path
-
string
Percorso pagina Wiki.
- recursionLevel
- VersionControlRecursionType
Livello di ricorsione per il recupero delle pagine secondarie. Il valore predefinito è None (facoltativo).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor per la pagina. Il valore predefinito è il ramo predefinito (facoltativo).
- includeContent
-
boolean
True per includere il contenuto della pagina nella risposta per il tipo di contenuto Json. Il valore predefinito è false (facoltativo)
Restituisce
Promise<ArrayBuffer>
getWiki(string, string)
Ottiene il wiki corrispondente all'ID wiki o al nome wiki specificato.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametri
- wikiIdentifier
-
string
ID wiki o nome wiki.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Restituisce un elenco di commenti pagable.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parametri
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- pageId
-
number
ID pagina wiki.
- top
-
number
Numero massimo di commenti da restituire.
- continuationToken
-
string
Consente di eseguire una query per la pagina successiva di commenti.
- excludeDeleted
-
boolean
Specificare se i commenti eliminati devono essere ignorati.
- expand
- CommentExpandOptions
Specifica le opzioni di recupero dati aggiuntive per i commenti.
- order
- CommentSortOrder
Ordine in cui devono essere restituiti i commenti.
- parentId
-
number
CommentId del commento padre.
Restituisce
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Aggiornare un commento in una pagina wiki.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parametri
- comment
- CommentUpdateParameters
Richiesta di aggiornamento dei commenti.
- project
-
string
ID progetto o nome del progetto
- wikiIdentifier
-
string
ID wiki o nome wiki.
- pageId
-
number
ID pagina wiki.
- id
-
number
ID commento.
Restituisce
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Aggiornamenti il wiki corrispondente all'ID wiki o al nome wiki fornito usando i parametri di aggiornamento.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parametri
- updateParameters
- WikiUpdateParameters
Aggiornare i parametri.
- wikiIdentifier
-
string
ID wiki o nome wiki.
- project
-
string
ID progetto o nome del progetto
Restituisce
Promise<WikiV2>