NotificationSubscriptionUpdateParameters interface
Parametry aktualizacji istniejącej subskrypcji. Subskrypcja definiuje kryteria dopasowania zdarzeń i sposobu powiadamiania subskrybenta subskrypcji o tych zdarzeniach. Uwaga: należy ustawić tylko pola do zaktualizowania.
Właściwości
| admin |
Ustawienia zarządzane przez administratora dla subskrypcji. Dotyczy tylko subskrypcji, w których subskrybent jest grupą. |
| channel | Kanał dostarczania powiadomień wyzwalanych przez subskrypcję. |
| description | Zaktualizowano opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają w tożsamości subskrypcji. |
| filter | Kryteria dopasowywania subskrypcji. Filtr wyrażeń |
| scope | Kontener, z którego należy publikować zdarzenia, aby dopasować je do nowej subskrypcji. Jeśli nie zostanie określony, wartość domyślna to bieżący host (zazwyczaj bieżące konto lub kolekcja projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych z projektu B. |
| status | Zaktualizowano stan subskrypcji. Zazwyczaj służy do włączania lub wyłączania subskrypcji. |
| status |
Komunikat opcjonalny, który zawiera więcej szczegółów dotyczących zaktualizowanego stanu. |
| user |
Ustawienia zarządzane przez użytkownika dla subskrypcji. Dotyczy tylko subskrypcji, w których subskrybent jest grupą. Zazwyczaj używane do rezygnacji lub rezygnacji użytkownika z subskrypcji grupy. |
Szczegóły właściwości
adminSettings
Ustawienia zarządzane przez administratora dla subskrypcji. Dotyczy tylko subskrypcji, w których subskrybent jest grupą.
adminSettings: SubscriptionAdminSettings
Wartość właściwości
channel
Kanał dostarczania powiadomień wyzwalanych przez subskrypcję.
channel: ISubscriptionChannel
Wartość właściwości
description
Zaktualizowano opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają w tożsamości subskrypcji.
description: string
Wartość właściwości
string
filter
Kryteria dopasowywania subskrypcji. Filtr wyrażeń
filter: ISubscriptionFilter
Wartość właściwości
scope
Kontener, z którego należy publikować zdarzenia, aby dopasować je do nowej subskrypcji. Jeśli nie zostanie określony, wartość domyślna to bieżący host (zazwyczaj bieżące konto lub kolekcja projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych z projektu B.
scope: SubscriptionScope
Wartość właściwości
status
Zaktualizowano stan subskrypcji. Zazwyczaj służy do włączania lub wyłączania subskrypcji.
status: SubscriptionStatus
Wartość właściwości
statusMessage
Komunikat opcjonalny, który zawiera więcej szczegółów dotyczących zaktualizowanego stanu.
statusMessage: string
Wartość właściwości
string
userSettings
Ustawienia zarządzane przez użytkownika dla subskrypcji. Dotyczy tylko subskrypcji, w których subskrybent jest grupą. Zazwyczaj używane do rezygnacji lub rezygnacji użytkownika z subskrypcji grupy.
userSettings: SubscriptionUserSettings