NotificationSubscription interface
Una sottoscrizione definisce i criteri per la corrispondenza degli eventi e il modo in cui il sottoscrittore della sottoscrizione deve ricevere una notifica su tali eventi.
Proprietà
| admin |
Impostazioni gestite dall'amministratore per la sottoscrizione. Si applica solo quando il sottoscrittore è un gruppo. |
| channel | Canale per il recapito di notifiche attivate dalla sottoscrizione. |
| description | Descrizione della sottoscrizione. Descrive in genere i criteri di filtro che consentono di identificare la sottoscrizione. |
| diagnostics | Diagnostica per questa sottoscrizione. |
| extended |
Eventuali proprietà aggiuntive, ad esempio una descrizione dettagliata per contesti diversi, contesti utente/gruppo |
| filter | Criteri di corrispondenza per la sottoscrizione. ExpressionFilter |
| flags | Indicatori di sola lettura che descrivono ulteriormente la sottoscrizione. |
| id | Identificatore della sottoscrizione. |
| last |
Utente che ha modificato (o creato) la sottoscrizione. |
| modified |
Data dell'ultima modifica della sottoscrizione. Se la sottoscrizione non è stata aggiornata dopo la creazione, questo valore indicherà quando è stata creata la sottoscrizione. |
| permissions | Le autorizzazioni che l'utente ha per queste sottoscrizioni. |
| scope | Contenitore in cui gli eventi devono essere pubblicati per poter corrispondere alla sottoscrizione. Se vuoto, l'ambito è l'host corrente (in genere un account o una raccolta di progetti). Ad esempio, una sottoscrizione con ambito progetto A non produrrà notifiche per gli eventi pubblicati dal progetto B. |
| status | Stato della sottoscrizione. In genere indica se la sottoscrizione è abilitata o meno. |
| status |
Messaggio che fornisce altri dettagli sullo stato della sottoscrizione. |
| subscriber | Utente o gruppo che riceverà notifiche per gli eventi corrispondenti ai criteri di filtro della sottoscrizione. |
| url | URL dell'API REST della sottoscrizione. |
| user |
Impostazioni gestite dall'utente per la sottoscrizione. Si applica solo quando il sottoscrittore è un gruppo. In genere viene usato per indicare se l'utente chiamante è consenso esplicito o esterno a una sottoscrizione di gruppo. |
Dettagli proprietà
adminSettings
Impostazioni gestite dall'amministratore per la sottoscrizione. Si applica solo quando il sottoscrittore è un gruppo.
adminSettings: SubscriptionAdminSettings
Valore della proprietà
channel
Canale per il recapito di notifiche attivate dalla sottoscrizione.
channel: ISubscriptionChannel
Valore della proprietà
description
Descrizione della sottoscrizione. Descrive in genere i criteri di filtro che consentono di identificare la sottoscrizione.
description: string
Valore della proprietà
string
diagnostics
Diagnostica per questa sottoscrizione.
diagnostics: SubscriptionDiagnostics
Valore della proprietà
extendedProperties
Eventuali proprietà aggiuntive, ad esempio una descrizione dettagliata per contesti diversi, contesti utente/gruppo
extendedProperties: {[key: string]: string}
Valore della proprietà
{[key: string]: string}
filter
Criteri di corrispondenza per la sottoscrizione. ExpressionFilter
filter: ISubscriptionFilter
Valore della proprietà
flags
Indicatori di sola lettura che descrivono ulteriormente la sottoscrizione.
flags: SubscriptionFlags
Valore della proprietà
id
Identificatore della sottoscrizione.
id: string
Valore della proprietà
string
lastModifiedBy
Utente che ha modificato (o creato) la sottoscrizione.
lastModifiedBy: IdentityRef
Valore della proprietà
modifiedDate
Data dell'ultima modifica della sottoscrizione. Se la sottoscrizione non è stata aggiornata dopo la creazione, questo valore indicherà quando è stata creata la sottoscrizione.
modifiedDate: Date
Valore della proprietà
Date
permissions
Le autorizzazioni che l'utente ha per queste sottoscrizioni.
permissions: SubscriptionPermissions
Valore della proprietà
scope
Contenitore in cui gli eventi devono essere pubblicati per poter corrispondere alla sottoscrizione. Se vuoto, l'ambito è l'host corrente (in genere un account o una raccolta di progetti). Ad esempio, una sottoscrizione con ambito progetto A non produrrà notifiche per gli eventi pubblicati dal progetto B.
scope: SubscriptionScope
Valore della proprietà
status
Stato della sottoscrizione. In genere indica se la sottoscrizione è abilitata o meno.
status: SubscriptionStatus
Valore della proprietà
statusMessage
Messaggio che fornisce altri dettagli sullo stato della sottoscrizione.
statusMessage: string
Valore della proprietà
string
subscriber
Utente o gruppo che riceverà notifiche per gli eventi corrispondenti ai criteri di filtro della sottoscrizione.
subscriber: IdentityRef
Valore della proprietà
url
URL dell'API REST della sottoscrizione.
url: string
Valore della proprietà
string
userSettings
Impostazioni gestite dall'utente per la sottoscrizione. Si applica solo quando il sottoscrittore è un gruppo. In genere viene usato per indicare se l'utente chiamante è consenso esplicito o esterno a una sottoscrizione di gruppo.
userSettings: SubscriptionUserSettings