WikiRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Wiki |
Propriedades
| RESOURCE_AREA_ID |
Métodos
| add |
Adicione um comentário em uma página wiki. |
| add |
Adicione uma reação em um comentário de página wiki. |
| create |
Carrega um anexo em um comentário em uma página wiki. |
| create |
Cria um novo recurso de estatísticas de exibição de página ou atualiza um recurso de estatísticas de exibição de página existente. |
| create |
Cria o recurso wiki. |
| delete |
Exclua um comentário em uma página wiki. |
| delete |
Exclua uma reação em um comentário de página wiki. |
| delete |
Exclui o wiki correspondente à ID wiki ou ao nome wiki fornecido. |
| get |
Obtém todos os wikis em um projeto ou coleção. |
| get |
Baixa um anexo em um comentário em uma página wiki. |
| get |
Retorna um comentário associado à Página wiki. |
| get |
Obtém uma lista de usuários que reagiram para o comentário wiki fornecido com um determinado tipo de reação. Dá suporte à paginação, com um tamanho de página padrão de 100 usuários por vez. |
| get |
Obtém metadados ou conteúdo da página wiki para a ID de página fornecida. A negociação de conteúdo é feita com base no |
| get |
Obtém metadados ou conteúdo da página wiki para a ID de página fornecida. A negociação de conteúdo é feita com base no |
| get |
Retorna detalhes da página correspondentes à ID da Página. |
| get |
Retorna uma lista paginável de Páginas Wiki |
| get |
Obtém metadados ou conteúdo da página wiki para o caminho fornecido. A negociação de conteúdo é feita com base no |
| get |
Obtém metadados ou conteúdo da página wiki para o caminho fornecido. A negociação de conteúdo é feita com base no |
| get |
Obtém o wiki correspondente à ID do wiki ou ao nome wiki fornecido. |
| list |
Retorna uma lista paginável de comentários. |
| update |
Atualize um comentário em uma página wiki. |
| update |
Atualizações o wiki correspondente à ID do wiki ou ao nome wiki fornecido usando os parâmetros de atualização. |
Detalhes do construtor
WikiRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do método
addComment(CommentCreateParameters, string, string, number)
Adicione um comentário em uma página wiki.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parâmetros
- request
- CommentCreateParameters
Comentário criar solicitação.
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do Wiki ou nome wiki.
- pageId
-
number
ID da página wiki.
Retornos
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Adicione uma reação em um comentário de página wiki.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do Wiki ou nome wiki
- pageId
-
number
ID da página wiki
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo da reação que está sendo adicionada
Retornos
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Carrega um anexo em um comentário em uma página wiki.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parâmetros
- content
-
any
Conteúdo a ser carregado
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do Wiki ou nome wiki.
- pageId
-
number
ID da página wiki.
Retornos
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Cria um novo recurso de estatísticas de exibição de página ou atualiza um recurso de estatísticas de exibição de página existente.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do Wiki ou nome wiki.
- wikiVersion
- GitVersionDescriptor
Versão do Wiki.
- path
-
string
Caminho da página wiki.
- oldPath
-
string
Caminho de página antigo. Isso é opcional e necessário para renomear o caminho em estatísticas de exibição de página existentes.
Retornos
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Cria o recurso wiki.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parâmetros
- wikiCreateParams
- WikiCreateParametersV2
Parâmetros para a criação do wiki.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WikiV2>
deleteComment(string, string, number, number)
Exclua um comentário em uma página wiki.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID ou nome do Wiki.
- pageId
-
number
ID da página wiki.
- id
-
number
ID do comentário.
Retornos
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Exclua uma reação em um comentário de página wiki.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID ou nome do Wiki
- pageId
-
number
ID da página wiki
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo da reação que está sendo excluída
Retornos
Promise<CommentReaction>
deleteWiki(string, string)
Exclui o wiki correspondente à ID wiki ou ao nome wiki fornecido.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parâmetros
- wikiIdentifier
-
string
ID do Wiki ou nome wiki.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WikiV2>
getAllWikis(string)
Obtém todos os wikis em um projeto ou coleção.
function getAllWikis(project?: string): Promise<WikiV2[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Baixa um anexo em um comentário em uma página wiki.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do Wiki ou nome wiki.
- pageId
-
number
ID da página wiki.
- attachmentId
-
string
ID do anexo.
Retornos
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Retorna um comentário associado à Página wiki.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- pageId
-
number
ID da página wiki.
- id
-
number
ID do comentário a ser retornado.
- excludeDeleted
-
boolean
Especifique se o comentário excluído deve ser ignorado.
- expand
- CommentExpandOptions
Especifica as opções adicionais de recuperação de dados para comentários.
Retornos
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Obtém uma lista de usuários que reagiram para o comentário wiki fornecido com um determinado tipo de reação. Dá suporte à paginação, com um tamanho de página padrão de 100 usuários por vez.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- pageId
-
number
ID da página wiki.
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo da reação para a qual os usuários envolvidos estão sendo solicitados
- top
-
number
Número de usuários enagagados a serem retornados em uma determinada página. Opcional, o padrão é 100
- skip
-
number
O número de usuários envolvidos a serem ignorados para a página do próximo conjunto de usuários envolvidos, o padrão é 0
Retornos
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Obtém metadados ou conteúdo da página wiki para a ID de página fornecida. A negociação de conteúdo é feita com base no Accept cabeçalho enviado na solicitação.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki..
- id
-
number
ID da página wiki.
- recursionLevel
- VersionControlRecursionType
Nível de recursão para recuperação de subpáginas. O padrão é None (opcional).
- includeContent
-
boolean
True para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. O padrão é false (opcional)
Retornos
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Obtém metadados ou conteúdo da página wiki para a ID de página fornecida. A negociação de conteúdo é feita com base no Accept cabeçalho enviado na solicitação.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki..
- id
-
number
ID da página wiki.
- recursionLevel
- VersionControlRecursionType
Nível de recursão para recuperação de subpáginas. O padrão é None (opcional).
- includeContent
-
boolean
True para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. O padrão é false (opcional)
Retornos
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Retorna detalhes da página correspondentes à ID da Página.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- pageId
-
number
ID da página wiki.
- pageViewsForDays
-
number
últimos N dias do dia atual para o qual os modos de exibição de página devem ser retornados. É inclusivo do dia atual.
Retornos
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Retorna uma lista paginável de Páginas Wiki
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parâmetros
- pagesBatchRequest
- WikiPagesBatchRequest
Solicitação de página do lote wiki.
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para a página. (Opcional no caso do ProjectWiki).
Retornos
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtém metadados ou conteúdo da página wiki para o caminho fornecido. A negociação de conteúdo é feita com base no Accept cabeçalho enviado na solicitação.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- path
-
string
Caminho da página wiki.
- recursionLevel
- VersionControlRecursionType
Nível de recursão para recuperação de subpáginas. O padrão é None (opcional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para a página. O padrão é o branch padrão (opcional).
- includeContent
-
boolean
True para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. O padrão é false (opcional)
Retornos
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Obtém metadados ou conteúdo da página wiki para o caminho fornecido. A negociação de conteúdo é feita com base no Accept cabeçalho enviado na solicitação.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- path
-
string
Caminho da página wiki.
- recursionLevel
- VersionControlRecursionType
Nível de recursão para recuperação de subpáginas. O padrão é None (opcional).
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para a página. O padrão é o branch padrão (opcional).
- includeContent
-
boolean
True para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. O padrão é false (opcional)
Retornos
Promise<ArrayBuffer>
getWiki(string, string)
Obtém o wiki correspondente à ID do wiki ou ao nome wiki fornecido.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parâmetros
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Retorna uma lista paginável de comentários.
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 do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- pageId
-
number
ID da página wiki.
- top
-
number
Número máximo de comentários a serem retornados.
- continuationToken
-
string
Usado para consultar a próxima página de comentários.
- excludeDeleted
-
boolean
Especifique se os comentários excluídos devem ser ignorados.
- expand
- CommentExpandOptions
Especifica as opções adicionais de recuperação de dados para comentários.
- order
- CommentSortOrder
Ordem na qual os comentários devem ser retornados.
- parentId
-
number
CommentId do comentário pai.
Retornos
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Atualize um comentário em uma página wiki.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parâmetros
- comment
- CommentUpdateParameters
Solicitação de atualização de comentário.
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- pageId
-
number
ID da página wiki.
- id
-
number
ID do comentário.
Retornos
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Atualizações o wiki correspondente à ID do wiki ou ao nome wiki fornecido usando os parâmetros de atualização.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parâmetros
- updateParameters
- WikiUpdateParameters
Atualizar parâmetros.
- wikiIdentifier
-
string
ID do wiki ou nome do wiki.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WikiV2>
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de