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 |
Agregue un comentario en una página wiki. |
| add |
Agregue una reacción en un comentario de página wiki. |
| create |
Carga datos adjuntos 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 |
Elimina una reacción en un comentario de página wiki. |
| delete |
Elimina la wiki correspondiente al identificador 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 a la página wiki. |
| get |
Obtiene una lista de los usuarios que han reaccionado para el comentario wiki dado con un tipo de reacción determinado. 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 del 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 del 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 identificador de página. |
| get |
Devuelve una lista paginable de páginas wiki. |
| get |
Obtiene metadatos o contenido de la página wiki de la ruta de acceso proporcionada. La negociación de contenido se realiza en función del |
| get |
Obtiene metadatos o contenido de la página wiki de la ruta de acceso proporcionada. La negociación de contenido se realiza en función del |
| get |
Obtiene la wiki correspondiente al identificador de wiki o al nombre de wiki proporcionado. |
| list |
Devuelve una lista paginable de comentarios. |
| update |
Actualizar un comentario en una página wiki. |
| update |
Novedades la wiki correspondiente al identificador de wiki o al nombre de 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)
Agregue 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 página wiki.
Devoluciones
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Agregue una reacción en un comentario de 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 página wiki
- commentId
-
number
Identificador del comentario asociado
- type
- CommentReactionType
Tipo de la reacción que se va a agregar
Devoluciones
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Carga datos adjuntos 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 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 acceso de la página wiki.
- oldPath
-
string
Ruta de acceso de página antigua. Esto es opcional y es necesario para cambiar el nombre de la ruta de acceso en las estadísticas de la vista 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 la wiki.
- 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. de wiki o nombre.
- pageId
-
number
Id. de página wiki.
- id
-
number
Id. de comentario.
Devoluciones
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Elimina una reacción en un comentario de 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 página wiki
- commentId
-
number
Identificador del comentario asociado
- type
- CommentReactionType
Tipo de la reacción que se va a eliminar
Devoluciones
Promise<CommentReaction>
deleteWiki(string, string)
Elimina la wiki correspondiente al identificador 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 página wiki.
- attachmentId
-
string
Id. de datos adjuntos.
Devoluciones
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Devuelve un comentario asociado a 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 página wiki.
- id
-
number
Identificador del comentario que se va a devolver.
- excludeDeleted
-
boolean
Especifique si se debe omitir el comentario eliminado.
- expand
- CommentExpandOptions
Especifica las opciones de recuperación de datos adicionales para los comentarios.
Devoluciones
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Obtiene una lista de los usuarios que han reaccionado para el comentario wiki dado con un tipo de reacción determinado. 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 página wiki.
- commentId
-
number
Identificador del comentario asociado
- type
- CommentReactionType
Tipo de reacción para la que se solicita a los usuarios comprometidos
- top
-
number
Número de usuarios enagados que se van a devolver en una página determinada. Opcional, el valor predeterminado es 100.
- skip
-
number
Número de usuarios comprometidos que se omitirán en la página del 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 del 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 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 del 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 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 identificador 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 página wiki.
- pageViewsForDays
-
number
últimos N días del día actual para el que se devolverán las vistas de página. Es inclusivo del día actual.
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 por lotes 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 de la ruta de acceso 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 acceso 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 de la ruta de acceso 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 acceso 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 la wiki correspondiente al identificador de wiki o al nombre de 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 página wiki.
- top
-
number
Número máximo de comentarios que se van a devolver.
- continuationToken
-
string
Se usa para consultar la página siguiente de comentarios.
- excludeDeleted
-
boolean
Especifique si se deben omitir los comentarios eliminados.
- expand
- CommentExpandOptions
Especifica las opciones de recuperación de datos adicionales 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 página wiki.
- id
-
number
Id. de comentario.
Devoluciones
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Novedades la wiki correspondiente al identificador de wiki o al nombre de wiki proporcionado mediante los parámetros de actualización.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parámetros
- updateParameters
- WikiUpdateParameters
Actualice los parámetros.
- wikiIdentifier
-
string
Id. de wiki o nombre de wiki.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WikiV2>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de