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 |
Excluir um comentário em uma página wiki. |
| delete |
Excluir uma reação em um comentário de página wiki. |
| delete |
Exclui o wiki correspondente ao ID wiki ou nome wiki fornecido. |
| get |
Obtém todos os wikis em um projeto ou coleção. |
| get |
Descarrega um anexo num comentário numa página wiki. |
| get |
Retorna um comentário associado à Página Wiki. |
| get |
Obtém uma lista de usuários que reagiram ao comentário wiki dado com um determinado tipo de reação. Suporta 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 da página fornecida. A negociação de conteúdo é feita com base no cabeçalho |
| get |
Obtém metadados ou conteúdo da página wiki para a ID da página fornecida. A negociação de conteúdo é feita com base no cabeçalho |
| get |
Retorna os detalhes da página correspondentes ao ID da página. |
| get |
Retorna 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 cabeçalho |
| 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 cabeçalho |
| get |
Obtém o wiki correspondente ao ID wiki ou nome wiki fornecido. |
| list |
Retorna uma lista paginável de comentários. |
| update |
Atualize um comentário em uma página wiki. |
| update |
Atualiza o wiki correspondente ao ID do wiki ou nome wiki fornecido usando os parâmetros de atualização. |
Detalhes do Construtor
WikiRestClient(IVssRestClientOptions)
Detalhes de Propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de Propriedade
string
Detalhes de 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 Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
Devoluções
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 Wiki ou nome wiki
- pageId
-
number
ID da página Wiki
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo de reação a ser adicionada
Devoluções
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 para carregar
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
Devoluções
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 Wiki ou nome wiki.
- wikiVersion
- GitVersionDescriptor
Versão Wiki.
- path
-
string
Caminho da página Wiki.
- oldPath
-
string
Caminho da página antiga. Isso é opcional e necessário para renomear o caminho nas estatísticas de exibição de página existentes.
Devoluções
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
Devoluções
Promise<WikiV2>
deleteComment(string, string, number, number)
Excluir 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.
Devoluções
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Excluir 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 Wiki
- pageId
-
number
ID da página Wiki
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo de reação que está a ser eliminada
Devoluções
Promise<CommentReaction>
deleteWiki(string, string)
Exclui o wiki correspondente ao ID wiki ou nome wiki fornecido.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parâmetros
- wikiIdentifier
-
string
ID Wiki ou nome wiki.
- project
-
string
ID do projeto ou nome do projeto
Devoluções
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
Devoluções
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Descarrega um anexo num comentário numa 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 Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
- attachmentId
-
string
ID do anexo.
Devoluções
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 Wiki ou nome 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.
Devoluções
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Obtém uma lista de usuários que reagiram ao comentário wiki dado com um determinado tipo de reação. Suporta 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 Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
- commentId
-
number
ID do comentário associado
- type
- CommentReactionType
Tipo de reação para a qual os usuários engajados estão sendo solicitados
- top
-
number
Número de usuários agredidos a serem retornados em uma determinada página. Opcional, o padrão é 100
- skip
-
number
Número de usuários engajados a serem ignorados para a página do próximo conjunto de usuários engajados, o padrão é 0
Devoluções
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Obtém metadados ou conteúdo da página wiki para a ID da página fornecida. A negociação de conteúdo é feita com base no cabeçalho Accept 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 Wiki ou nome 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)
Devoluções
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Obtém metadados ou conteúdo da página wiki para a ID da página fornecida. A negociação de conteúdo é feita com base no cabeçalho Accept 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 Wiki ou nome 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)
Devoluções
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Retorna os detalhes da página correspondentes ao 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 Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
- pageViewsForDays
-
number
últimos N dias a partir do dia atual para o qual as visualizações de página devem ser retornadas. Inclusive os dias atuais.
Devoluções
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Retorna 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 em lote Wiki.
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID Wiki ou nome wiki.
- versionDescriptor
- GitVersionDescriptor
GitVersionDescriptor para a página. (Opcional no caso do ProjectWiki).
Devoluções
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 cabeçalho Accept 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 Wiki ou nome 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 é a ramificação 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)
Devoluções
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 cabeçalho Accept 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 Wiki ou nome 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 é a ramificação 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)
Devoluções
Promise<ArrayBuffer>
getWiki(string, string)
Obtém o wiki correspondente ao ID wiki ou nome wiki fornecido.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parâmetros
- wikiIdentifier
-
string
ID Wiki ou nome wiki.
- project
-
string
ID do projeto ou nome do projeto
Devoluções
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 Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
- top
-
number
Número máximo de comentários a retornar.
- 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 em que os comentários devem ser devolvidos.
- parentId
-
number
CommentId do comentário pai.
Devoluções
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
Pedido de atualização de comentários.
- project
-
string
ID do projeto ou nome do projeto
- wikiIdentifier
-
string
ID Wiki ou nome wiki.
- pageId
-
number
ID da página Wiki.
- id
-
number
ID do comentário.
Devoluções
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Atualiza o wiki correspondente ao ID do wiki ou 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 Wiki ou nome wiki.
- project
-
string
ID do projeto ou nome do projeto
Devoluções
Promise<WikiV2>