WikiRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

WikiRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addComment(CommentCreateParameters, string, string, number)	Adicionar um comentário numa página wiki.
addCommentReaction(string, string, number, number, CommentReactionType)	Adicione uma reação num comentário de página wiki.
createCommentAttachment(any, string, string, number)	Carrega um anexo num comentário numa página wiki.
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)	Cria um novo recurso de estatísticas de vista de página ou atualiza um recurso de estatísticas de vista de página existente.
createWiki(WikiCreateParametersV2, string)	Cria o recurso wiki.
deleteComment(string, string, number, number)	Eliminar um comentário numa página wiki.
deleteCommentReaction(string, string, number, number, CommentReactionType)	Eliminar uma reação num comentário de página wiki.
deleteWiki(string, string)	Elimina o wiki correspondente ao ID wiki ou ao nome wiki fornecido.
getAllWikis(string)	Obtém todos os wikis num projeto ou coleção.
getAttachmentContent(string, string, number, string)	Transfere um anexo num comentário numa página wiki.
getComment(string, string, number, number, boolean, CommentExpandOptions)	Devolve um comentário associado à Página Wiki.
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)	Obtém uma lista de utilizadores que reagiram ao comentário wiki fornecido com um determinado tipo de reação. Suporta a paginação, com um tamanho de página predefinido de 100 utilizadores de cada vez.
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)	Obtém metadados ou conteúdos da página wiki para o ID de página fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)	Obtém metadados ou conteúdos da página wiki para o ID de página fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.
getPageData(string, string, number, number)	Devolve o detalhe da página correspondente ao ID da Página.
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)	Devolve a lista paginável de Páginas Wiki
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Obtém metadados ou conteúdos da página wiki para o caminho fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)	Obtém metadados ou conteúdos da página wiki para o caminho fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.
getWiki(string, string)	Obtém o wiki correspondente ao ID wiki ou ao nome wiki fornecido.
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)	Devolve uma lista paginável de comentários.
updateComment(CommentUpdateParameters, string, string, number, number)	Atualizar um comentário numa página wiki.
updateWiki(WikiUpdateParameters, string, string)	Atualizações wiki correspondente ao ID wiki ou ao nome wiki fornecido com os parâmetros de atualização.

Detalhes do Construtor

WikiRestClient(IVssRestClientOptions)

new WikiRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addComment(CommentCreateParameters, string, string, number)

Adicionar um comentário numa página wiki.

function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>

Parâmetros

request

CommentCreateParameters

Pedido de criaçã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.

Devoluções

Promise<Comment>

addCommentReaction(string, string, number, number, CommentReactionType)

Adicione uma reação num 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 num comentário numa página wiki.

function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>

Parâmetros

content

any

Conteúdo a 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 vista de página ou atualiza um recurso de estatí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 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 de página antigo. Isto é opcional e é necessário para mudar o nome do caminho nas estatísticas de vista 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)

Eliminar um comentário numa 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)

Eliminar uma reação num 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 de reação a ser eliminada

Devoluções

Promise<CommentReaction>

deleteWiki(string, string)

Elimina o wiki correspondente ao ID wiki ou ao 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 num 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)

Transfere 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)

Devolve 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 devolver.

excludeDeleted

boolean

Especifique se o comentário eliminado deve ser ignorado.

expand

CommentExpandOptions

Especifica as opções adicionais de obtenção de dados para comentários.

Devoluções

Promise<Comment>

getEngagedUsers(string, string, number, number, CommentReactionType, number, number)

Obtém uma lista de utilizadores que reagiram ao comentário wiki fornecido com um determinado tipo de reação. Suporta a paginação, com um tamanho de página predefinido de 100 utilizadores de cada 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 utilizadores envolvidos estão a ser solicitados

top

number

Número de utilizadores enagagados a serem devolvidos numa determinada página. Opcional, predefinição para 100

skip

number

Número de utilizadores envolvidos a serem ignorados para a página do próximo conjunto de utilizadores envolvidos, predefinições para 0

Devoluções

Promise<IdentityRef[]>

getPageByIdText(string, string, number, VersionControlRecursionType, boolean)

Obtém metadados ou conteúdos da página wiki para o ID de página fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.

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 a obtenção de subpáginas. Predefinições para None (Opcional).

includeContent

boolean

Verdadeiro para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. Predefinições para falso (Opcional)

Devoluções

Promise<string>

getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)

Obtém metadados ou conteúdos da página wiki para o ID de página fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.

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 a obtenção de subpáginas. Predefinições para None (Opcional).

includeContent

boolean

Verdadeiro para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. Predefinições para falso (Opcional)

Devoluções

Promise<ArrayBuffer>

getPageData(string, string, number, number)

Devolve o detalhe da página correspondente 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 vistas de página devem ser devolvidas. É inclusivo do dia atual.

Devoluções

Promise<WikiPageDetail>

getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)

Devolve a lista paginável de Páginas Wiki

function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>

Parâmetros

pagesBatchRequest

WikiPagesBatchRequest

Pedido de página de 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údos da página wiki para o caminho fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.

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 a obtenção de subpáginas. Predefinições para None (Opcional).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor para a página. Predefinição para o ramo predefinido (Opcional).

includeContent

boolean

Verdadeiro para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. Predefinições para falso (Opcional)

Devoluções

Promise<string>

getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)

Obtém metadados ou conteúdos da página wiki para o caminho fornecido. A negociação de conteúdos é efetuada com base no Accept cabeçalho enviado no pedido.

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 a obtenção de subpáginas. Predefinições para None (Opcional).

versionDescriptor

GitVersionDescriptor

GitVersionDescriptor para a página. Predefinição para o ramo predefinido (Opcional).

includeContent

boolean

Verdadeiro para incluir o conteúdo da página na resposta para o tipo de conteúdo Json. Predefinições para falso (Opcional)

Devoluções

Promise<ArrayBuffer>

getWiki(string, string)

Obtém o wiki correspondente ao ID wiki ou ao 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)

Devolve 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 devolver.

continuationToken

string

Utilizado para consultar para a página seguinte de comentários.

excludeDeleted

boolean

Especifique se os comentários eliminados devem ser ignorados.

expand

CommentExpandOptions

Especifica as opções adicionais de obtenção de dados para comentários.

order

CommentSortOrder

Ordem pela qual os comentários devem ser devolvidos.

parentId

number

CommentId do comentário principal.

Devoluções

Promise<CommentList>

updateComment(CommentUpdateParameters, string, string, number, number)

Atualizar um comentário numa 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ções wiki correspondente ao ID wiki ou ao nome wiki fornecido com 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>