NotificationRestClient class

new NotificationRestClient(options: IVssRestClientOptions)

Parâmetros

Criar uma nova subscrição.

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

Parâmetros

Devoluções

Eliminar uma subscrição.

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

Parâmetros

Devoluções

Obter um tipo de evento específico.

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

function getSettings(): Promise<NotificationAdminSettings>

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Obter modelos de subscrição disponíveis.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Devoluções

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

Devoluções

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

Devoluções

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

Parâmetros

Devoluções

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

Devoluções

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

Parâmetros

Devoluções

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

Devoluções

Transforme um evento de notificação.

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

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

Devoluções