WikiRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Wiki |
Propiedades
| RESOURCE_AREA_ID |
Métodos
| add |
Añadir un comentario en una página wiki. |
| add |
Añade una reacción en un comentario de la página wiki. |
| create |
Sube un archivo adjunto en un comentario en una página wiki. |
| create |
Crea un nuevo recurso de estadísticas de vista de página o actualiza un recurso de estadísticas de vista de página existente. |
| create |
Crea el recurso wiki. |
| delete |
Eliminar un comentario en una página wiki. |
| delete |
Eliminar una reacción en un comentario de la página wiki. |
| delete |
Elimina la wiki correspondiente al ID de wiki o al nombre de wiki proporcionado. |
| get |
Obtiene todos los wikis de un proyecto o colección. |
| get |
Descarga un archivo adjunto en un comentario en una página wiki. |
| get |
Devuelve un comentario asociado con la página Wiki. |
| get |
Obtiene una lista de usuarios que han reaccionado por el comentario wiki dado con un tipo de reacción dado. Admite la paginación, con un tamaño de página predeterminado de 100 usuarios a la vez. |
| get |
Obtiene metadatos o contenido de la página wiki para el identificador de página proporcionado. La negociación de contenido se realiza en función del |
| get |
Obtiene metadatos o contenido de la página wiki para el identificador de página proporcionado. La negociación de contenido se realiza en función del |
| get |
Devuelve los detalles de la página correspondientes al ID de página. |
| get |
Devuelve una lista paginable de páginas Wiki |
| get |
Obtiene metadatos o contenido de la página wiki para la ruta proporcionada. La negociación de contenido se realiza en función del |
| get |
Obtiene metadatos o contenido de la página wiki para la ruta proporcionada. La negociación de contenido se realiza en función del |
| get |
Obtiene el wiki correspondiente al ID de wiki o al nombre del wiki proporcionado. |
| list |
Devuelve una lista paginable de comentarios. |
| update |
Actualizar un comentario en una página wiki. |
| update |
Actualiza el wiki correspondiente al ID de wiki o al nombre del wiki proporcionado mediante los parámetros de actualización. |
Detalles del constructor
WikiRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
addComment(CommentCreateParameters, string, string, number)
Añadir un comentario en una página wiki.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parámetros
- request
- CommentCreateParameters
Solicitud de creación de comentarios.
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
Devoluciones
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Añade una reacción en un comentario de la página wiki.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki
- pageId
-
number
ID de la página wiki
- commentId
-
number
ID del comentario asociado
- type
- CommentReactionType
Tipo de reacción que se agrega
Devoluciones
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Sube un archivo adjunto en un comentario en una página wiki.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parámetros
- content
-
any
Contenido que se va a cargar
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
Devoluciones
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Crea un nuevo recurso de estadísticas de vista de página o actualiza un recurso de estadísticas de vista de página existente.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- wikiVersion
- GitVersionDescriptor
Versión Wiki.
- path
-
string
Ruta de la página wiki.
- oldPath
-
string
Ruta de página antigua. Esto es opcional y necesario para cambiar el nombre de la ruta en las estadísticas de vistas de página existentes.
Devoluciones
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Crea el recurso wiki.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parámetros
- wikiCreateParams
- WikiCreateParametersV2
Parámetros para la creación de wikis.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2>
deleteComment(string, string, number, number)
Eliminar un comentario en una página wiki.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID o nombre de Wiki.
- pageId
-
number
ID de la página Wiki.
- id
-
number
ID de comentario.
Devoluciones
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Eliminar una reacción en un comentario de la página wiki.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID o nombre de Wiki
- pageId
-
number
ID de la página wiki
- commentId
-
number
ID del comentario asociado
- type
- CommentReactionType
Tipo de reacción que se elimina
Devoluciones
Promise<CommentReaction>
deleteWiki(string, string)
Elimina la wiki correspondiente al ID de wiki o al nombre de wiki proporcionado.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parámetros
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2>
getAllWikis(string)
Obtiene todos los wikis de un proyecto o colección.
function getAllWikis(project?: string): Promise<WikiV2[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Descarga un archivo adjunto en un comentario en una página wiki.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- attachmentId
-
string
ID de archivo adjunto.
Devoluciones
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Devuelve un comentario asociado con la página Wiki.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- id
-
number
ID del comentario que se va a devolver.
- excludeDeleted
-
boolean
Especifique si se debe omitir el comentario eliminado.
- expand
- CommentExpandOptions
Especifica las opciones adicionales de recuperación de datos para los comentarios.
Devoluciones
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Obtiene una lista de usuarios que han reaccionado por el comentario wiki dado con un tipo de reacción dado. Admite la paginación, con un tamaño de página predeterminado de 100 usuarios a la vez.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- commentId
-
number
ID del comentario asociado
- type
- CommentReactionType
Tipo de reacción para la que se solicita a los usuarios comprometidos
- top
-
number
Número de usuarios agregados que se devolverán en una página determinada. Opcional, el valor predeterminado es 100
- skip
-
number
Número de usuarios comprometidos que se omitirán para paginar el siguiente conjunto de usuarios comprometidos, el valor predeterminado es 0
Devoluciones
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Obtiene metadatos o contenido de la página wiki para el identificador de página proporcionado. La negociación de contenido se realiza en función del Accept encabezado enviado en la solicitud.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki..
- id
-
number
ID de la página Wiki.
- recursionLevel
- VersionControlRecursionType
Nivel de recursividad para la recuperación de subpáginas. El valor predeterminado es None (Opcional).
- includeContent
-
boolean
True para incluir el contenido de la página en la respuesta para el tipo de contenido Json. El valor predeterminado es false (opcional)
Devoluciones
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Obtiene metadatos o contenido de la página wiki para el identificador de página proporcionado. La negociación de contenido se realiza en función del Accept encabezado enviado en la solicitud.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki..
- id
-
number
ID de la página Wiki.
- recursionLevel
- VersionControlRecursionType
Nivel de recursividad para la recuperación de subpáginas. El valor predeterminado es None (Opcional).
- includeContent
-
boolean
True para incluir el contenido de la página en la respuesta para el tipo de contenido Json. El valor predeterminado es false (opcional)
Devoluciones
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Devuelve los detalles de la página correspondientes al ID de página.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- pageViewsForDays
-
number
últimos N días a partir del día actual para el que se devolverán las vistas de página. Es inclusivo de la actualidad.
Devoluciones
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Devuelve una lista paginable de páginas Wiki
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parámetros
- pagesBatchRequest
- WikiPagesBatchRequest
Solicitud de página de lote wiki.
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para la página. (Opcional en el caso de ProjectWiki).
Devoluciones
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtiene metadatos o contenido de la página wiki para la ruta proporcionada. La negociación de contenido se realiza en función del Accept encabezado enviado en la solicitud.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- path
-
string
Ruta de la página wiki.
- recursionLevel
- VersionControlRecursionType
Nivel de recursividad para la recuperación de subpáginas. El valor predeterminado es None (Opcional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para la página. El valor predeterminado es la rama predeterminada (opcional).
- includeContent
-
boolean
True para incluir el contenido de la página en la respuesta para el tipo de contenido Json. El valor predeterminado es false (opcional)
Devoluciones
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtiene metadatos o contenido de la página wiki para la ruta proporcionada. La negociación de contenido se realiza en función del Accept encabezado enviado en la solicitud.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- path
-
string
Ruta de la página wiki.
- recursionLevel
- VersionControlRecursionType
Nivel de recursividad para la recuperación de subpáginas. El valor predeterminado es None (Opcional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para la página. El valor predeterminado es la rama predeterminada (opcional).
- includeContent
-
boolean
True para incluir el contenido de la página en la respuesta para el tipo de contenido Json. El valor predeterminado es false (opcional)
Devoluciones
Promise<ArrayBuffer>
getWiki(string, string)
Obtiene el wiki correspondiente al ID de wiki o al nombre del wiki proporcionado.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parámetros
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Devuelve una lista paginable de comentarios.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- top
-
number
Número máximo de comentarios a devolver.
- continuationToken
-
string
Se utiliza para consultar la siguiente página de comentarios.
- excludeDeleted
-
boolean
Especifique si se deben omitir los comentarios eliminados.
- expand
- CommentExpandOptions
Especifica las opciones adicionales de recuperación de datos para los comentarios.
- order
- CommentSortOrder
Orden en el que se deben devolver los comentarios.
- parentId
-
number
CommentId del comentario primario.
Devoluciones
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Actualizar un comentario en una página wiki.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parámetros
- comment
- CommentUpdateParameters
Solicitud de actualización de comentarios.
- project
-
string
Id. de proyecto o nombre del proyecto
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- pageId
-
number
ID de la página Wiki.
- id
-
number
ID de comentario.
Devoluciones
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Actualiza el wiki correspondiente al ID de wiki o al nombre del wiki proporcionado mediante los parámetros de actualización.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parámetros
- updateParameters
- WikiUpdateParameters
Actualizar parámetros.
- wikiIdentifier
-
string
ID de wiki o nombre de wiki.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2>