NotificationRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

NotificationRestClient(IVssRestClientOptions)

Métodos

createSubscription(NotificationSubscriptionCreateParameters)	Cree una nueva suscripción.
deleteSubscription(string)	Eliminar una suscripción.
getEventType(string)	Obtiene un tipo de evento específico.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Obtiene las preferencias de entrega de un suscriptor de notificaciones.
getSubscription(string, SubscriptionQueryFlags)	Obtenga una suscripción de notificación por su identificador.
getSubscriptionDiagnostics(string)	Obtenga la configuración de diagnóstico de una suscripción.
getSubscriptionTemplates()	Obtenga las plantillas de suscripción disponibles.
listEventTypes(string)	Enumere los tipos de eventos disponibles para este servicio. Opcionalmente, filtre solo por tipos de eventos para el publicador especificado.
listLogs(string, string, Date, Date)	Obtenga una lista de registros de diagnóstico para este servicio.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Obtenga una lista de suscripciones de notificación, ya sea por identificadores de suscripción o por todas las suscripciones de un usuario o grupo determinado.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publicar un evento. Esta solicitud debe dirigirse al servicio "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publicar un evento. Esta solicitud solo es para el servicio de token, ya que es un servicio de implementación.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Consulta de suscripciones. Se devuelve una suscripción si coincide con una o varias de las condiciones especificadas.
transformEvent(EventTransformRequest)	Transforme un evento de notificación.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Actualizar las preferencias de entrega de un suscriptor de notificaciones.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Actualice una suscripción existente. Según el tipo de suscripción y los permisos, el autor de la llamada puede actualizar la descripción, la configuración de filtro, la configuración del canal (entrega) y mucho más.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Actualice la configuración de diagnóstico de una suscripción.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Actualice la configuración del usuario especificado para la suscripción especificada. Esta API se usa normalmente para participar o no en una suscripción compartida. La configuración de usuario solo se puede aplicar a las suscripciones compartidas, como las suscripciones de equipo o las suscripciones predeterminadas.

Detalles del constructor

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

createSubscription(NotificationSubscriptionCreateParameters)

Cree una nueva suscripción.

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

Parámetros

createParameters

NotificationSubscriptionCreateParameters

Devoluciones

Promise<NotificationSubscription>

deleteSubscription(string)

Eliminar una suscripción.

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

Parámetros

subscriptionId

string

Devoluciones

Promise<void>

getEventType(string)

Obtiene un tipo de evento específico.

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

Parámetros

eventType

string

Identificador del tipo de evento.

Devoluciones

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parámetros

notificationId

number

Devoluciones

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Devoluciones

Promise<NotificationAdminSettings>

getSubscriber(string)

Obtiene las preferencias de entrega de un suscriptor de notificaciones.

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

Parámetros

subscriberId

string

Identificador del usuario o grupo.

Devoluciones

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Obtenga una suscripción de notificación por su identificador.

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

Parámetros

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Devoluciones

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Obtenga la configuración de diagnóstico de una suscripción.

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

Parámetros

subscriptionId

string

Identificador de la suscripción de notificaciones.

Devoluciones

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Obtenga las plantillas de suscripción disponibles.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Devoluciones

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Enumere los tipos de eventos disponibles para este servicio. Opcionalmente, filtre solo por tipos de eventos para el publicador especificado.

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

Parámetros

publisherId

string

Límite de tipos de eventos para este publicador

Devoluciones

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Obtenga una lista de registros de diagnóstico para este servicio.

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

Parámetros

source

string

Identificador que especifica el tipo de registros para el que se va a comprobar el diagnóstico.

entryId

string

Identificador del registro específico para el que se va a consultar.

startTime

Date

Hora de inicio del intervalo de tiempo en el que se va a consultar.

endTime

Date

Hora de finalización del intervalo de tiempo en el que se va a consultar.

Devoluciones

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parámetros

notificationIds

number

Devoluciones

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Obtenga una lista de suscripciones de notificación, ya sea por identificadores de suscripción o por todas las suscripciones de un usuario o grupo determinado.

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

Parámetros

targetId

string

Id. de usuario o grupo

ids

string[]

Lista de identificadores de suscripción

queryFlags

SubscriptionQueryFlags

Devoluciones

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parámetros

operation

BatchNotificationOperation

Devoluciones

Promise<void>

publishEvent(VssNotificationEvent)

Publicar un evento. Esta solicitud debe dirigirse al servicio "extmgmt".

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

Parámetros

notificationEvent

VssNotificationEvent

Devoluciones

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publicar un evento. Esta solicitud solo es para el servicio de token, ya que es un servicio de implementación.

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

Parámetros

notificationEvent

VssNotificationEvent

Devoluciones

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parámetros

inputValuesQuery

FieldValuesQuery

eventType

string

Devoluciones

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Consulta de suscripciones. Se devuelve una suscripción si coincide con una o varias de las condiciones especificadas.

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

Parámetros

subscriptionQuery

SubscriptionQuery

Devoluciones

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transforme un evento de notificación.

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

Parámetros

transformRequest

EventTransformRequest

Objeto que se va a transformar.

Devoluciones

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parámetros

updateParameters

NotificationAdminSettingsUpdateParameters

Devoluciones

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Actualizar las preferencias de entrega de un suscriptor de notificaciones.

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

Parámetros

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

Identificador del usuario o grupo.

Devoluciones

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Actualice una suscripción existente. Según el tipo de suscripción y los permisos, el autor de la llamada puede actualizar la descripción, la configuración de filtro, la configuración del canal (entrega) y mucho más.

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

Parámetros

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Devoluciones

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Actualice la configuración de diagnóstico de una suscripción.

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

Parámetros

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Identificador de la suscripción de notificaciones.

Devoluciones

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Actualice la configuración del usuario especificado para la suscripción especificada. Esta API se usa normalmente para participar o no en una suscripción compartida. La configuración de usuario solo se puede aplicar a las suscripciones compartidas, como las suscripciones de equipo o las suscripciones predeterminadas.

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

Parámetros

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

Identificador del usuario

Devoluciones

Promise<SubscriptionUserSettings>