WikiRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- Extends
Constructeurs
| Wiki |
Propriétés
| RESOURCE_AREA_ID |
Méthodes
| add |
Ajoutez un commentaire sur une page wiki. |
| add |
Ajouter une réaction sur un commentaire de page wiki. |
| create |
Charge une pièce jointe sur un commentaire sur une page wiki. |
| create |
Crée une ressource de statistiques d’affichage de page ou met à jour une ressource de statistiques d’affichage de page existante. |
| create |
Crée la ressource wiki. |
| delete |
Supprimez un commentaire sur une page wiki. |
| delete |
Supprimez une réaction sur un commentaire de page wiki. |
| delete |
Supprime le wiki correspondant à l’ID wiki ou au nom wiki fourni. |
| get |
Obtient tous les wikis d’un projet ou d’une collection. |
| get |
Télécharge une pièce jointe sur un commentaire sur une page wiki. |
| get |
Retourne un commentaire associé à la page Wiki. |
| get |
Obtient une liste d’utilisateurs qui ont réagi pour le commentaire wiki donné avec un type de réaction donné. Prend en charge la pagination, avec une taille de page par défaut de 100 utilisateurs à la fois. |
| get |
Obtient les métadonnées ou le contenu de la page wiki pour l’ID de page fourni. La négociation de contenu est effectuée en fonction de l’en-tête |
| get |
Obtient les métadonnées ou le contenu de la page wiki pour l’ID de page fourni. La négociation de contenu est effectuée en fonction de l’en-tête |
| get |
Retourne les détails de la page correspondant à l’ID de page. |
| get |
Retourne la liste paginable des pages Wiki |
| get |
Obtient les métadonnées ou le contenu de la page wiki pour le chemin d’accès fourni. La négociation de contenu est effectuée en fonction de l’en-tête |
| get |
Obtient les métadonnées ou le contenu de la page wiki pour le chemin d’accès fourni. La négociation de contenu est effectuée en fonction de l’en-tête |
| get |
Obtient le wiki correspondant à l’ID wiki ou au nom wiki fourni. |
| list |
Retourne une liste paginable de commentaires. |
| update |
Mettez à jour un commentaire sur une page wiki. |
| update |
Met à jour le wiki correspondant à l’ID wiki ou au nom wiki fourni à l’aide des paramètres de mise à jour. |
Détails du constructeur
WikiRestClient(IVssRestClientOptions)
Détails de la propriété
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValeur de propriété
string
Détails de la méthode
addComment(CommentCreateParameters, string, string, number)
Ajoutez un commentaire sur une page wiki.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Paramètres
- request
- CommentCreateParameters
Demande de création de commentaire.
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
Retours
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Ajouter une réaction sur un commentaire de page wiki.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki
- pageId
-
number
Wiki page ID
- commentId
-
number
ID du commentaire associé
- type
- CommentReactionType
Type de réaction ajoutée
Retours
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Charge une pièce jointe sur un commentaire sur une page wiki.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Paramètres
- content
-
any
Contenu à charger
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
Retours
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Crée une ressource de statistiques d’affichage de page ou met à jour une ressource de statistiques d’affichage de page existante.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- wikiVersion
- GitVersionDescriptor
Version wiki.
- path
-
string
Chemin d’accès à la page Wiki.
- oldPath
-
string
Chemin d’accès à l’ancienne page. Cette option est facultative et nécessaire pour renommer le chemin d’accès dans les statistiques d’affichage de page existantes.
Retours
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Crée la ressource wiki.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Paramètres
- wikiCreateParams
- WikiCreateParametersV2
Paramètres de la création du wiki.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<WikiV2>
deleteComment(string, string, number, number)
Supprimez un commentaire sur une page wiki.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID ou nom wiki.
- pageId
-
number
ID de page Wiki.
- id
-
number
ID de commentaire.
Retours
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Supprimez une réaction sur un commentaire de page wiki.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID ou nom du Wiki
- pageId
-
number
Wiki page ID
- commentId
-
number
ID du commentaire associé
- type
- CommentReactionType
Type de la réaction en cours de suppression
Retours
Promise<CommentReaction>
deleteWiki(string, string)
Supprime le wiki correspondant à l’ID wiki ou au nom wiki fourni.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Paramètres
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<WikiV2>
getAllWikis(string)
Obtient tous les wikis d’un projet ou d’une collection.
function getAllWikis(project?: string): Promise<WikiV2[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Télécharge une pièce jointe sur un commentaire sur une page wiki.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- attachmentId
-
string
ID de pièce jointe.
Retours
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Retourne un commentaire associé à la page Wiki.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- id
-
number
ID du commentaire à retourner.
- excludeDeleted
-
boolean
Spécifiez si le commentaire supprimé doit être ignoré.
- expand
- CommentExpandOptions
Spécifie les options de récupération de données supplémentaires pour les commentaires.
Retours
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Obtient une liste d’utilisateurs qui ont réagi pour le commentaire wiki donné avec un type de réaction donné. Prend en charge la pagination, avec une taille de page par défaut de 100 utilisateurs à la fois.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- commentId
-
number
ID du commentaire associé
- type
- CommentReactionType
Type de réaction pour laquelle les utilisateurs engagés sont demandés
- top
-
number
Nombre d’utilisateurs enagés à retourner dans une page donnée. Facultatif, la valeur par défaut est 100
- skip
-
number
Nombre d’utilisateurs engagés à ignorer pour pager l’ensemble suivant d’utilisateurs engagés, la valeur par défaut est 0
Retours
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Obtient les métadonnées ou le contenu de la page wiki pour l’ID de page fourni. La négociation de contenu est effectuée en fonction de l’en-tête Accept envoyé dans la requête.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki..
- id
-
number
ID de page Wiki.
- recursionLevel
- VersionControlRecursionType
Niveau de récursivité pour la récupération des sous-pages. Valeur par défaut None (facultatif).
- includeContent
-
boolean
True pour inclure le contenu de la page dans la réponse pour le type de contenu Json. Valeurs par défaut sur false (facultatif)
Retours
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Obtient les métadonnées ou le contenu de la page wiki pour l’ID de page fourni. La négociation de contenu est effectuée en fonction de l’en-tête Accept envoyé dans la requête.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki..
- id
-
number
ID de page Wiki.
- recursionLevel
- VersionControlRecursionType
Niveau de récursivité pour la récupération des sous-pages. Valeur par défaut None (facultatif).
- includeContent
-
boolean
True pour inclure le contenu de la page dans la réponse pour le type de contenu Json. Valeurs par défaut sur false (facultatif)
Retours
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Retourne les détails de la page correspondant à l’ID de page.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- pageViewsForDays
-
number
derniers jours du jour actuel pour lequel les vues de page doivent être retournées. C’est inclusif de la journée actuelle.
Retours
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Retourne la liste paginable des pages Wiki
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Paramètres
- pagesBatchRequest
- WikiPagesBatchRequest
Demande de page de lot Wiki.
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pour la page. (Facultatif en cas de ProjectWiki).
Retours
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtient les métadonnées ou le contenu de la page wiki pour le chemin d’accès fourni. La négociation de contenu est effectuée en fonction de l’en-tête Accept envoyé dans la requête.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- path
-
string
Chemin d’accès à la page Wiki.
- recursionLevel
- VersionControlRecursionType
Niveau de récursivité pour la récupération des sous-pages. Valeur par défaut None (facultatif).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pour la page. Valeur par défaut de la branche par défaut (facultatif).
- includeContent
-
boolean
True pour inclure le contenu de la page dans la réponse pour le type de contenu Json. Valeurs par défaut sur false (facultatif)
Retours
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtient les métadonnées ou le contenu de la page wiki pour le chemin d’accès fourni. La négociation de contenu est effectuée en fonction de l’en-tête Accept envoyé dans la requête.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- path
-
string
Chemin d’accès à la page Wiki.
- recursionLevel
- VersionControlRecursionType
Niveau de récursivité pour la récupération des sous-pages. Valeur par défaut None (facultatif).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor pour la page. Valeur par défaut de la branche par défaut (facultatif).
- includeContent
-
boolean
True pour inclure le contenu de la page dans la réponse pour le type de contenu Json. Valeurs par défaut sur false (facultatif)
Retours
Promise<ArrayBuffer>
getWiki(string, string)
Obtient le wiki correspondant à l’ID wiki ou au nom wiki fourni.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Paramètres
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Retourne une liste paginable de commentaires.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Paramètres
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- top
-
number
Nombre maximal de commentaires à retourner.
- continuationToken
-
string
Utilisé pour rechercher la page suivante des commentaires.
- excludeDeleted
-
boolean
Spécifiez si les commentaires supprimés doivent être ignorés.
- expand
- CommentExpandOptions
Spécifie les options de récupération de données supplémentaires pour les commentaires.
- order
- CommentSortOrder
Ordre dans lequel les commentaires doivent être retournés.
- parentId
-
number
CommentId du commentaire parent.
Retours
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Mettez à jour un commentaire sur une page wiki.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Paramètres
- comment
- CommentUpdateParameters
Demande de mise à jour de commentaires.
- project
-
string
ID de projet ou nom du projet
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- pageId
-
number
ID de page Wiki.
- id
-
number
ID de commentaire.
Retours
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Met à jour le wiki correspondant à l’ID wiki ou au nom wiki fourni à l’aide des paramètres de mise à jour.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Paramètres
- updateParameters
- WikiUpdateParameters
Mettez à jour les paramètres.
- wikiIdentifier
-
string
ID wiki ou nom wiki.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<WikiV2>