NotificationRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

RestClientBase

Construtores

NotificationRestClient(IVssRestClientOptions)

Métodos

createSubscription(NotificationSubscriptionCreateParameters)	Crie uma nova assinatura.
deleteSubscription(string)	Excluir uma assinatura.
getEventType(string)	Obter um tipo de evento específico.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Obtenha as preferências de entrega de um assinante de notificações.
getSubscription(string, SubscriptionQueryFlags)	Obtenha uma assinatura de notificação por sua ID.
getSubscriptionDiagnostics(string)	Obtenha as configurações de diagnóstico de uma assinatura.
getSubscriptionTemplates()	Obter modelos de assinatura disponíveis.
listEventTypes(string)	Listar os tipos de eventos disponíveis para esse serviço. Opcionalmente, filtre apenas por tipos de evento para o publicador especificado.
listLogs(string, string, Date, Date)	Obtenha uma lista de logs de diagnóstico para esse serviço.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Obtenha uma lista de assinaturas de notificação, por IDs de assinatura ou por todas as assinaturas de um determinado usuário ou grupo.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publicar um evento. Essa solicitação deve ser direcionada para o serviço "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publicar um evento. Essa solicitação é apenas para o serviço token, pois é um serviço somente de implantação.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Consultar assinaturas. Uma assinatura será retornada se corresponder a uma ou mais das condições especificadas.
transformEvent(EventTransformRequest)	Transforme um evento de notificação.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Atualize as preferências de entrega de um assinante de notificações.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Atualizar uma assinatura existente. Dependendo do tipo de assinatura e permissões, o chamador pode atualizar a descrição, as configurações de filtro, as configurações de canal (entrega) e muito mais.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Atualize as configurações de diagnóstico de uma assinatura.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Atualize as configurações do usuário especificado para a assinatura especificada. Normalmente, essa API é usada para aceitar ou desativar uma assinatura compartilhada. As configurações do usuário só podem ser aplicadas a assinaturas compartilhadas, como assinaturas de equipe ou assinaturas padrão.

Detalhes do construtor

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

createSubscription(NotificationSubscriptionCreateParameters)

Crie uma nova assinatura.

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

Parâmetros

createParameters

NotificationSubscriptionCreateParameters

Retornos

Promise<NotificationSubscription>

deleteSubscription(string)

Excluir uma assinatura.

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

Parâmetros

subscriptionId

string

Retornos

Promise<void>

getEventType(string)

Obter um tipo de evento específico.

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

Parâmetros

eventType

string

A ID do tipo de evento.

Retornos

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parâmetros

notificationId

number

Retornos

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Retornos

Promise<NotificationAdminSettings>

getSubscriber(string)

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

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

Parâmetros

subscriberId

string

ID do usuário ou grupo.

Retornos

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Obtenha uma assinatura de notificação por sua ID.

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

Parâmetros

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Retornos

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Obtenha as configurações de diagnóstico de uma assinatura.

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

Parâmetros

subscriptionId

string

A ID da assinatura de notificações.

Retornos

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Obter modelos de assinatura disponíveis.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Retornos

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

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

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

Parâmetros

publisherId

string

Limite para tipos de eventos para este editor

Retornos

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Obtenha uma lista de logs de diagnóstico para esse serviço.

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

Parâmetros

source

string

ID especificando para qual tipo de logs marcar diagnóstico.

entryId

string

A ID do log específico para consulta.

startTime

Date

Hora de início do intervalo de tempo no qual consultar.

endTime

Date

Hora de término do intervalo de tempo no qual consultar.

Retornos

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parâmetros

notificationIds

number

Retornos

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Obtenha uma lista de assinaturas de notificação, por IDs de assinatura ou por todas as assinaturas de um determinado usuário ou grupo.

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

Parâmetros

targetId

string

ID de usuário ou grupo

ids

string[]

Lista de IDs de assinatura

queryFlags

SubscriptionQueryFlags

Retornos

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parâmetros

operation

BatchNotificationOperation

Retornos

Promise<void>

publishEvent(VssNotificationEvent)

Publicar um evento. Essa solicitação deve ser direcionada para o serviço "extmgmt".

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

Parâmetros

notificationEvent

VssNotificationEvent

Retornos

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publicar um evento. Essa solicitação é apenas para o serviço token, pois é um serviço somente de implantação.

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

Parâmetros

notificationEvent

VssNotificationEvent

Retornos

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parâmetros

inputValuesQuery

FieldValuesQuery

eventType

string

Retornos

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Consultar assinaturas. Uma assinatura será retornada se corresponder a uma ou mais das condições especificadas.

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

Parâmetros

subscriptionQuery

SubscriptionQuery

Retornos

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transforme um evento de notificação.

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

Parâmetros

transformRequest

EventTransformRequest

Objeto a ser transformado.

Retornos

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parâmetros

updateParameters

NotificationAdminSettingsUpdateParameters

Retornos

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Atualize as preferências de entrega de um assinante de notificações.

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

Parâmetros

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID do usuário ou grupo.

Retornos

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Atualizar uma assinatura existente. Dependendo do tipo de assinatura e permissões, o chamador pode atualizar a descrição, as configurações de filtro, as configurações de canal (entrega) e muito mais.

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

Parâmetros

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Retornos

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Atualize as configurações de diagnóstico de uma assinatura.

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

Parâmetros

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

A ID da assinatura de notificações.

Retornos

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Atualize as configurações do usuário especificado para a assinatura especificada. Normalmente, essa API é usada para aceitar ou desativar uma assinatura compartilhada. As configurações do usuário só podem ser aplicadas a assinaturas compartilhadas, como assinaturas de equipe ou assinaturas padrão.

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

Parâmetros

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID do usuário

Retornos

Promise<SubscriptionUserSettings>