NotificationSubscriptionUpdateParameters interface
Parâmetros para atualizar uma assinatura existente. Uma assinatura define critérios para eventos correspondentes e como o assinante da assinatura deve ser notificado sobre esses eventos. Observação: somente os campos a serem atualizados devem ser definidos.
Propriedades
| admin |
Configurações gerenciadas pelo administrador para a assinatura. Aplica-se apenas a assinaturas em que o assinante é um grupo. |
| channel | Canal para entrega de notificações acionadas pela assinatura. |
| description | Descrição atualizada da assinatura. Normalmente, descreve os critérios de filtro que ajudam a identificar a assinatura. |
| filter | Critérios de correspondência para a assinatura. Filtro de Expressão |
| scope | O contêiner no qual os eventos devem ser publicados para serem correspondidos pela nova assinatura. Se não for especificado, o padrão será o host atual (normalmente a conta atual ou a coleção de projetos). Por exemplo, uma assinatura com escopo para o projeto A não produzirá notificações para eventos publicados do projeto B. |
| status | Status atualizado para a assinatura. Normalmente usado para habilitar ou desabilitar uma assinatura. |
| status |
Mensagem opcional que fornece mais detalhes sobre o status atualizado. |
| user |
Configurações gerenciadas pelo usuário para a assinatura. Aplica-se apenas a assinaturas em que o assinante é um grupo. Normalmente usado para aceitar ou recusar um usuário de uma assinatura de grupo. |
Detalhes da propriedade
adminSettings
Configurações gerenciadas pelo administrador para a assinatura. Aplica-se apenas a assinaturas em que o assinante é um grupo.
adminSettings: SubscriptionAdminSettings
Valor da propriedade
channel
Canal para entrega de notificações acionadas pela assinatura.
channel: ISubscriptionChannel
Valor da propriedade
description
Descrição atualizada da assinatura. Normalmente, descreve os critérios de filtro que ajudam a identificar a assinatura.
description: string
Valor da propriedade
string
filter
Critérios de correspondência para a assinatura. Filtro de Expressão
filter: ISubscriptionFilter
Valor da propriedade
scope
O contêiner no qual os eventos devem ser publicados para serem correspondidos pela nova assinatura. Se não for especificado, o padrão será o host atual (normalmente a conta atual ou a coleção de projetos). Por exemplo, uma assinatura com escopo para o projeto A não produzirá notificações para eventos publicados do projeto B.
scope: SubscriptionScope
Valor da propriedade
status
Status atualizado para a assinatura. Normalmente usado para habilitar ou desabilitar uma assinatura.
status: SubscriptionStatus
Valor da propriedade
statusMessage
Mensagem opcional que fornece mais detalhes sobre o status atualizado.
statusMessage: string
Valor da propriedade
string
userSettings
Configurações gerenciadas pelo usuário para a assinatura. Aplica-se apenas a assinaturas em que o assinante é um grupo. Normalmente usado para aceitar ou recusar um usuário de uma assinatura de grupo.
userSettings: SubscriptionUserSettings