NotificationSubscriptionUpdateParameters interface
Parameter untuk memperbarui langganan yang sudah ada. Langganan menentukan kriteria untuk peristiwa yang cocok dan bagaimana pelanggan langganan harus diberi tahu tentang peristiwa tersebut. Catatan: hanya bidang yang akan diperbarui yang harus diatur.
Properti
| admin |
Pengaturan yang dikelola admin untuk langganan. Hanya berlaku untuk langganan di mana subscriber adalah grup. |
| channel | Saluran untuk mengirimkan notifikasi yang dipicu oleh langganan. |
| description | Deskripsi yang diperbarui untuk langganan. Biasanya menjelaskan kriteria filter yang membantu mengidentifikasi langganan. |
| filter | Kriteria pencocokan untuk langganan. Filter Ekspresi |
| scope | Kontainer tempat peristiwa harus diterbitkan agar dapat dicocokkan dengan langganan baru. Jika tidak ditentukan, default ke host saat ini (biasanya akun saat ini atau koleksi proyek). Misalnya, langganan yang dicakup ke proyek A tidak akan menghasilkan pemberitahuan untuk peristiwa yang diterbitkan dari proyek B. |
| status | Status yang diperbarui untuk langganan. Biasanya digunakan untuk mengaktifkan atau menonaktifkan langganan. |
| status |
Pesan opsional yang memberikan detail selengkapnya tentang status yang diperbarui. |
| user |
Pengaturan yang dikelola pengguna untuk langganan. Hanya berlaku untuk langganan di mana subscriber adalah grup. Biasanya digunakan untuk memilih untuk ikut serta atau memilih keluar pengguna dari langganan grup. |
Detail Properti
adminSettings
Pengaturan yang dikelola admin untuk langganan. Hanya berlaku untuk langganan di mana subscriber adalah grup.
adminSettings: SubscriptionAdminSettings
Nilai Properti
channel
Saluran untuk mengirimkan notifikasi yang dipicu oleh langganan.
channel: ISubscriptionChannel
Nilai Properti
description
Deskripsi yang diperbarui untuk langganan. Biasanya menjelaskan kriteria filter yang membantu mengidentifikasi langganan.
description: string
Nilai Properti
string
filter
Kriteria pencocokan untuk langganan. Filter Ekspresi
filter: ISubscriptionFilter
Nilai Properti
scope
Kontainer tempat peristiwa harus diterbitkan agar dapat dicocokkan dengan langganan baru. Jika tidak ditentukan, default ke host saat ini (biasanya akun saat ini atau koleksi proyek). Misalnya, langganan yang dicakup ke proyek A tidak akan menghasilkan pemberitahuan untuk peristiwa yang diterbitkan dari proyek B.
scope: SubscriptionScope
Nilai Properti
status
Status yang diperbarui untuk langganan. Biasanya digunakan untuk mengaktifkan atau menonaktifkan langganan.
status: SubscriptionStatus
Nilai Properti
statusMessage
Pesan opsional yang memberikan detail selengkapnya tentang status yang diperbarui.
statusMessage: string
Nilai Properti
string
userSettings
Pengaturan yang dikelola pengguna untuk langganan. Hanya berlaku untuk langganan di mana subscriber adalah grup. Biasanya digunakan untuk memilih untuk ikut serta atau memilih keluar pengguna dari langganan grup.
userSettings: SubscriptionUserSettings