NotificationRestClient 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

NotificationRestClient(IVssRestClientOptions)

Métodos

createSubscription(NotificationSubscriptionCreateParameters)	Criar uma nova subscrição.
deleteSubscription(string)	Eliminar uma subscrição.
getEventType(string)	Obter um tipo de evento específico.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Obtenha as preferências de entrega de um subscritor de notificações.
getSubscription(string, SubscriptionQueryFlags)	Obtenha uma subscrição de notificação pelo respetivo ID.
getSubscriptionDiagnostics(string)	Obtenha as definições de diagnóstico de uma subscrição.
getSubscriptionTemplates()	Obter modelos de subscrição disponíveis.
listEventTypes(string)	Listar os tipos de eventos disponíveis para este serviço. Opcionalmente, filtre apenas por tipos de eventos para o publicador especificado.
listLogs(string, string, Date, Date)	Obtenha uma lista de registos de diagnóstico para este serviço.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Obtenha uma lista de subscrições de notificação, quer por IDs de subscrição, quer por todas as subscrições de um determinado utilizador ou grupo.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publicar um evento. Este pedido tem de ser direcionado para o serviço "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publicar um evento. Este pedido destina-se apenas ao serviço Token, uma vez que se trata de um serviço apenas de implementação.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Consultar subscrições. Uma subscrição é devolvida se corresponder a uma ou mais das condições especificadas.
transformEvent(EventTransformRequest)	Transforme um evento de notificação.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Atualizar as preferências de entrega de um subscritor de notificações.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Atualizar uma subscrição existente. Dependendo do tipo de subscrição e permissões, o autor da chamada pode atualizar a descrição, as definições de filtro, as definições do canal (entrega) e muito mais.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Atualize as definições de diagnóstico de uma subscrição.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Atualize as definições do utilizador especificado para a subscrição especificada. Normalmente, esta API é utilizada para ativar ou desativar uma subscrição partilhada. As definições de utilizador só podem ser aplicadas a subscrições partilhadas, como subscrições de equipa ou subscrições predefinidas.

Detalhes do Construtor

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

createSubscription(NotificationSubscriptionCreateParameters)

Criar uma nova subscrição.

function createSubscription(createParameters: NotificationSubscriptionCreateParameters): Promise<NotificationSubscription>

Parâmetros

createParameters

NotificationSubscriptionCreateParameters

Devoluções

Promise<NotificationSubscription>

deleteSubscription(string)

Eliminar uma subscrição.

function deleteSubscription(subscriptionId: string): Promise<void>

Parâmetros

subscriptionId

string

Devoluções

Promise<void>

getEventType(string)

Obter um tipo de evento específico.

function getEventType(eventType: string): Promise<NotificationEventType>

Parâmetros

eventType

string

O ID do tipo de evento.

Devoluções

Promise<NotificationEventType>

getNotificationReasons(number)

function getNotificationReasons(notificationId: number): Promise<NotificationReason>

Parâmetros

notificationId

number

Devoluções

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Devoluções

Promise<NotificationAdminSettings>

getSubscriber(string)

Obtenha as preferências de entrega de um subscritor de notificações.

function getSubscriber(subscriberId: string): Promise<NotificationSubscriber>

Parâmetros

subscriberId

string

ID do utilizador ou grupo.

Devoluções

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Obtenha uma subscrição de notificação pelo respetivo ID.

function getSubscription(subscriptionId: string, queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription>

Parâmetros

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Devoluções

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Obtenha as definições de diagnóstico de uma subscrição.

function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>

Parâmetros

subscriptionId

string

O ID da subscrição de notificações.

Devoluções

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Obter modelos de subscrição disponíveis.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Devoluções

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Listar os tipos de eventos disponíveis para este serviço. Opcionalmente, filtre apenas por tipos de eventos para o publicador especificado.

function listEventTypes(publisherId?: string): Promise<NotificationEventType[]>

Parâmetros

publisherId

string

Limitar a tipos de eventos para este publicador

Devoluções

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Obtenha uma lista de registos de diagnóstico para este serviço.

function listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<INotificationDiagnosticLog[]>

Parâmetros

source

string

ID a especificar para que tipo de registos verificar os diagnósticos.

entryId

string

O ID do registo específico para o que consultar.

startTime

Date

Hora de início para o intervalo de tempo no qual consultar.

endTime

Date

Hora de fim para o intervalo de tempo para consultar.

Devoluções

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

function listNotificationReasons(notificationIds?: number): Promise<NotificationReason[]>

Parâmetros

notificationIds

number

Devoluções

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Obtenha uma lista de subscrições de notificação, quer por IDs de subscrição, quer por todas as subscrições de um determinado utilizador ou grupo.

function listSubscriptions(targetId?: string, ids?: string[], queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription[]>

Parâmetros

targetId

string

ID de Utilizador ou Grupo

ids

string[]

Lista de IDs de subscrição

queryFlags

SubscriptionQueryFlags

Devoluções

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

function performBatchNotificationOperations(operation: BatchNotificationOperation): Promise<void>

Parâmetros

operation

BatchNotificationOperation

Devoluções

Promise<void>

publishEvent(VssNotificationEvent)

Publicar um evento. Este pedido tem de ser direcionado para o serviço "extmgmt".

function publishEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

Parâmetros

notificationEvent

VssNotificationEvent

Devoluções

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publicar um evento. Este pedido destina-se apenas ao serviço Token, uma vez que se trata de um serviço apenas de implementação.

function publishTokenEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

Parâmetros

notificationEvent

VssNotificationEvent

Devoluções

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

function queryEventTypes(inputValuesQuery: FieldValuesQuery, eventType: string): Promise<NotificationEventField[]>

Parâmetros

inputValuesQuery

FieldValuesQuery

eventType

string

Devoluções

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Consultar subscrições. Uma subscrição é devolvida se corresponder a uma ou mais das condições especificadas.

function querySubscriptions(subscriptionQuery: SubscriptionQuery): Promise<NotificationSubscription[]>

Parâmetros

subscriptionQuery

SubscriptionQuery

Devoluções

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transforme um evento de notificação.

function transformEvent(transformRequest: EventTransformRequest): Promise<EventTransformResult>

Parâmetros

transformRequest

EventTransformRequest

Objeto a ser transformado.

Devoluções

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

function updateSettings(updateParameters: NotificationAdminSettingsUpdateParameters): Promise<NotificationAdminSettings>

Parâmetros

updateParameters

NotificationAdminSettingsUpdateParameters

Devoluções

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Atualizar as preferências de entrega de um subscritor de notificações.

function updateSubscriber(updateParameters: NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationSubscriber>

Parâmetros

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID do utilizador ou grupo.

Devoluções

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Atualizar uma subscrição existente. Dependendo do tipo de subscrição e permissões, o autor da chamada pode atualizar a descrição, as definições de filtro, as definições do canal (entrega) e muito mais.

function updateSubscription(updateParameters: NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationSubscription>

Parâmetros

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Devoluções

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Atualize as definições de diagnóstico de uma subscrição.

function updateSubscriptionDiagnostics(updateParameters: UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<SubscriptionDiagnostics>

Parâmetros

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

O ID da subscrição de notificações.

Devoluções

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Atualize as definições do utilizador especificado para a subscrição especificada. Normalmente, esta API é utilizada para ativar ou desativar uma subscrição partilhada. As definições de utilizador só podem ser aplicadas a subscrições partilhadas, como subscrições de equipa ou subscrições predefinidas.

function updateSubscriptionUserSettings(userSettings: SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<SubscriptionUserSettings>

Parâmetros

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID do utilizador

Devoluções

Promise<SubscriptionUserSettings>