NotificationSubscription interface

Paket:

azure-devops-extension-api

Langganan menentukan kriteria untuk peristiwa yang cocok dan bagaimana pelanggan langganan harus diberi tahu tentang peristiwa tersebut.

Properti

adminSettings	Pengaturan yang dikelola admin untuk langganan. Hanya berlaku ketika pelanggan adalah grup.
channel	Saluran untuk mengirimkan pemberitahuan yang dipicu oleh langganan.
description	Deskripsi langganan. Biasanya menjelaskan kriteria filter yang membantu identitas langganan.
diagnostics	Diagnostik untuk langganan ini.
extendedProperties	Properti tambahan apa pun seperti deskripsi terperinci untuk konteks, konteks pengguna/grup yang berbeda
filter	Kriteria pencocokan untuk langganan. ExpressionFilter
flags	Indikator baca-saja yang menjelaskan langganan lebih lanjut.
id	Pengidentifikasi langganan.
lastModifiedBy	Pengguna yang terakhir mengubah (atau membuat) langganan.
modifiedDate	Tanggal saat langganan terakhir diubah. Jika langganan belum diperbarui sejak dibuat, nilai ini akan menunjukkan kapan langganan dibuat.
permissions	Izin yang dimiliki pengguna untuk langganan ini.
scope	Kontainer tempat peristiwa harus diterbitkan agar cocok dengan langganan. Jika kosong, cakupannya adalah host saat ini (biasanya akun atau koleksi proyek). Misalnya, langganan yang dilingkup ke proyek A tidak akan menghasilkan pemberitahuan untuk peristiwa yang diterbitkan dari proyek B.
status	Status langganan. Biasanya menunjukkan apakah langganan diaktifkan atau tidak.
statusMessage	Pesan yang menyediakan detail selengkapnya tentang status langganan.
subscriber	Pengguna atau grup yang akan menerima pemberitahuan untuk peristiwa yang cocok dengan kriteria filter langganan.
url	URL REST API langganan.
userSettings	Pengaturan yang dikelola pengguna untuk langganan. Hanya berlaku ketika pelanggan adalah grup. Biasanya digunakan untuk menunjukkan apakah pengguna panggilan memilih ikut atau keluar dari langganan grup.

Detail Properti

adminSettings

Pengaturan yang dikelola admin untuk langganan. Hanya berlaku ketika pelanggan adalah grup.

adminSettings: SubscriptionAdminSettings

Nilai Properti

SubscriptionAdminSettings

channel

Saluran untuk mengirimkan pemberitahuan yang dipicu oleh langganan.

channel: ISubscriptionChannel

Nilai Properti

ISubscriptionChannel

description

Deskripsi langganan. Biasanya menjelaskan kriteria filter yang membantu identitas langganan.

description: string

Nilai Properti

string

diagnostics

Diagnostik untuk langganan ini.

diagnostics: SubscriptionDiagnostics

Nilai Properti

SubscriptionDiagnostics

extendedProperties

Properti tambahan apa pun seperti deskripsi terperinci untuk konteks, konteks pengguna/grup yang berbeda

extendedProperties: {[key: string]: string}

Nilai Properti

{[key: string]: string}

filter

Kriteria pencocokan untuk langganan. ExpressionFilter

filter: ISubscriptionFilter

Nilai Properti

ISubscriptionFilter

flags

Indikator baca-saja yang menjelaskan langganan lebih lanjut.

flags: SubscriptionFlags

Nilai Properti

SubscriptionFlags

id

Pengidentifikasi langganan.

id: string

Nilai Properti

string

lastModifiedBy

Pengguna yang terakhir mengubah (atau membuat) langganan.

lastModifiedBy: IdentityRef

Nilai Properti

IdentityRef

modifiedDate

Tanggal saat langganan terakhir diubah. Jika langganan belum diperbarui sejak dibuat, nilai ini akan menunjukkan kapan langganan dibuat.

modifiedDate: Date

Nilai Properti

Date

permissions

Izin yang dimiliki pengguna untuk langganan ini.

permissions: SubscriptionPermissions

Nilai Properti

SubscriptionPermissions

scope

Kontainer tempat peristiwa harus diterbitkan agar cocok dengan langganan. Jika kosong, cakupannya adalah host saat ini (biasanya akun atau koleksi proyek). Misalnya, langganan yang dilingkup ke proyek A tidak akan menghasilkan pemberitahuan untuk peristiwa yang diterbitkan dari proyek B.

scope: SubscriptionScope

Nilai Properti

SubscriptionScope

status

Status langganan. Biasanya menunjukkan apakah langganan diaktifkan atau tidak.

status: SubscriptionStatus

Nilai Properti

SubscriptionStatus

statusMessage

Pesan yang menyediakan detail selengkapnya tentang status langganan.

statusMessage: string

Nilai Properti

string

subscriber

Pengguna atau grup yang akan menerima pemberitahuan untuk peristiwa yang cocok dengan kriteria filter langganan.

subscriber: IdentityRef

Nilai Properti

IdentityRef

url

URL REST API langganan.

url: string

Nilai Properti

string

userSettings

Pengaturan yang dikelola pengguna untuk langganan. Hanya berlaku ketika pelanggan adalah grup. Biasanya digunakan untuk menunjukkan apakah pengguna panggilan memilih ikut atau keluar dari langganan grup.

userSettings: SubscriptionUserSettings

Nilai Properti

SubscriptionUserSettings