Delen via


NotificationSubscriptionUpdateParameters interface

Parameters voor het bijwerken van een bestaand abonnement. Een abonnement definieert criteria voor overeenkomende gebeurtenissen en hoe de abonnee van het abonnement op de hoogte moet worden gesteld van deze gebeurtenissen. Opmerking: alleen de velden die moeten worden bijgewerkt, moeten worden ingesteld.

Eigenschappen

adminSettings

Door de beheerder beheerde instellingen voor het abonnement. Geldt alleen voor abonnementen waarbij de abonnee een groep is.

channel

Kanaal voor het leveren van meldingen die door het abonnement worden geactiveerd.

description

Bijgewerkte beschrijving voor het abonnement. Beschrijft doorgaans filtercriteria die helpen bij het identificeren van het abonnement.

filter

Overeenkomende criteria voor het abonnement. Expressie Filter

scope

De container waaruit gebeurtenissen moeten worden gepubliceerd om te worden gekoppeld aan het nieuwe abonnement. Als dit niet is opgegeven, wordt standaard de huidige host gebruikt (meestal het huidige account of de huidige projectverzameling). Een abonnement dat is afgestemd op project A produceert bijvoorbeeld geen meldingen voor gebeurtenissen die zijn gepubliceerd vanuit project B.

status

Bijgewerkte status voor het abonnement. Wordt meestal gebruikt om een abonnement in of uit te schakelen.

statusMessage

Optioneel bericht met meer informatie over de bijgewerkte status.

userSettings

Door de gebruiker beheerde instellingen voor het abonnement. Geldt alleen voor abonnementen waarbij de abonnee een groep is. Wordt meestal gebruikt om een gebruiker aan of af te melden voor een groepsabonnement.

Eigenschapdetails

adminSettings

Door de beheerder beheerde instellingen voor het abonnement. Geldt alleen voor abonnementen waarbij de abonnee een groep is.

adminSettings: SubscriptionAdminSettings

Waarde van eigenschap

channel

Kanaal voor het leveren van meldingen die door het abonnement worden geactiveerd.

channel: ISubscriptionChannel

Waarde van eigenschap

description

Bijgewerkte beschrijving voor het abonnement. Beschrijft doorgaans filtercriteria die helpen bij het identificeren van het abonnement.

description: string

Waarde van eigenschap

string

filter

Overeenkomende criteria voor het abonnement. Expressie Filter

filter: ISubscriptionFilter

Waarde van eigenschap

scope

De container waaruit gebeurtenissen moeten worden gepubliceerd om te worden gekoppeld aan het nieuwe abonnement. Als dit niet is opgegeven, wordt standaard de huidige host gebruikt (meestal het huidige account of de huidige projectverzameling). Een abonnement dat is afgestemd op project A produceert bijvoorbeeld geen meldingen voor gebeurtenissen die zijn gepubliceerd vanuit project B.

scope: SubscriptionScope

Waarde van eigenschap

status

Bijgewerkte status voor het abonnement. Wordt meestal gebruikt om een abonnement in of uit te schakelen.

status: SubscriptionStatus

Waarde van eigenschap

statusMessage

Optioneel bericht met meer informatie over de bijgewerkte status.

statusMessage: string

Waarde van eigenschap

string

userSettings

Door de gebruiker beheerde instellingen voor het abonnement. Geldt alleen voor abonnementen waarbij de abonnee een groep is. Wordt meestal gebruikt om een gebruiker aan of af te melden voor een groepsabonnement.

userSettings: SubscriptionUserSettings

Waarde van eigenschap