MessagingOptions interface

Antarmuka yang mewakili opsi yang dapat diberikan saat mengirim pesan melalui API lama FCM.

Lihat Membangun permintaan pengiriman untuk contoh kode dan dokumentasi terperinci.

Tanda tangan:

export interface MessagingOptions 

Properti

Properti Jenis Keterangan
runtuhKey rangkaian String yang mengidentifikasi sekelompok pesan (misalnya, "Pembaruan Tersedia") yang dapat diciutkan, sehingga hanya pesan terakhir yang dikirim saat pengiriman dapat dilanjutkan. Hal ini digunakan untuk menghindari pengiriman terlalu banyak pesan yang sama ketika perangkat kembali online atau aktif. Tidak ada jaminan urutan pengiriman pesan. Maksimum empat kunci penciutan berbeda diperbolehkan pada waktu tertentu. Ini berarti server FCM dapat secara bersamaan menyimpan empat pesan kirim-untuk-sinkronisasi yang berbeda per aplikasi klien. Jika Anda melebihi jumlah ini, tidak ada jaminan empat kunci penciutan mana yang akan disimpan oleh server FCM. **Nilai default:** Tidak ada
konten Tersedia boolean Di iOS, gunakan kolom ini untuk mewakili content-available di payload APN. Ketika pemberitahuan atau pesan data dikirim dan ini disetel ke true , aplikasi klien yang tidak aktif akan dibangunkan. Di Android, pesan data membangunkan aplikasi secara default. Di Chrome, tanda ini saat ini tidak didukung. **Nilai default:** false
lari kering boolean Apakah pesan itu benar-benar harus dikirim atau tidak. Jika disetel ke true , memungkinkan pengembang menguji permintaan tanpa benar-benar mengirimkan pesan. Jika disetel ke false , pesan akan dikirim. **Nilai default:** false
konten yang bisa berubah boolean Di iOS, gunakan bidang ini untuk mewakili mutable-content dalam payload APN. Ketika pemberitahuan dikirim dan ini disetel ke true , konten pemberitahuan dapat diubah sebelum ditampilkan, menggunakan ekstensi aplikasi Layanan Pemberitahuan . Di Android dan Web, parameter ini akan diabaikan. **Nilai default:** false
prioritas rangkaian Prioritas pesan. Nilai yang valid adalah "normal" dan "high". Di iOS, ini sesuai dengan prioritas APN 5 dan 10 . Secara default, pesan notifikasi dikirim dengan prioritas tinggi, dan pesan data dikirim dengan prioritas normal. Prioritas normal mengoptimalkan konsumsi baterai aplikasi klien dan harus digunakan kecuali diperlukan pengiriman segera. Untuk pesan dengan prioritas normal, aplikasi mungkin menerima pesan dengan penundaan yang tidak ditentukan. Ketika pesan dikirim dengan prioritas tinggi, pesan tersebut segera dikirim, dan aplikasi dapat membangunkan perangkat yang sedang tidur dan membuka koneksi jaringan ke server Anda. Untuk informasi lebih lanjut, lihat Mengatur prioritas pesan . **Nilai default:** "high" untuk pesan notifikasi, "normal" untuk pesan data
dibatasiNamaPaket rangkaian Nama paket aplikasi yang token registrasinya harus cocok untuk menerima pesan. **Nilai default:** Tidak ada
waktuUntukHidup nomor Berapa lama (dalam detik) pesan harus disimpan di penyimpanan FCM jika perangkat sedang offline. Waktu maksimum untuk hidup yang didukung adalah empat minggu, dan nilai defaultnya juga empat minggu. Untuk informasi lebih lanjut, lihat Mengatur masa pakai pesan . **Nilai default:** 2419200 (mewakili empat minggu, dalam hitungan detik)

MessagingOptions.collapseKey

String yang mengidentifikasi sekelompok pesan (misalnya, "Pembaruan Tersedia") yang dapat diciutkan, sehingga hanya pesan terakhir yang dikirim saat pengiriman dapat dilanjutkan. Hal ini digunakan untuk menghindari pengiriman terlalu banyak pesan yang sama ketika perangkat kembali online atau aktif.

Tidak ada jaminan urutan pengiriman pesan.

Maksimum empat kunci penciutan berbeda diperbolehkan pada waktu tertentu. Ini berarti server FCM dapat secara bersamaan menyimpan empat pesan kirim-untuk-sinkronisasi yang berbeda per aplikasi klien. Jika Anda melebihi jumlah ini, tidak ada jaminan empat kunci penciutan mana yang akan disimpan oleh server FCM.

**Nilai default:** Tidak ada

Tanda tangan:

collapseKey?: string;

MessagingOptions.contentAvailable

Di iOS, gunakan kolom ini untuk mewakili content-available di payload APN. Ketika pemberitahuan atau pesan data dikirim dan ini disetel ke true , aplikasi klien yang tidak aktif akan dibangunkan. Di Android, pesan data membangunkan aplikasi secara default. Di Chrome, tanda ini saat ini tidak didukung.

**Nilai default:** false

Tanda tangan:

contentAvailable?: boolean;

Opsi Pesan.dryRun

Apakah pesan itu benar-benar harus dikirim atau tidak. Jika disetel ke true , memungkinkan pengembang menguji permintaan tanpa benar-benar mengirimkan pesan. Saat disetel ke false , pesan akan terkirim.

**Nilai default:** false

Tanda tangan:

dryRun?: boolean;

MessagingOptions.mutableContent

Di iOS, gunakan bidang ini untuk mewakili mutable-content dalam payload APN. Ketika pemberitahuan dikirim dan ini disetel ke true , konten notifikasi dapat diubah sebelum ditampilkan, menggunakan ekstensi aplikasi Layanan Notifikasi .

Di Android dan Web, parameter ini akan diabaikan.

**Nilai default:** false

Tanda tangan:

mutableContent?: boolean;

MessagingOptions.prioritas

Prioritas pesan. Nilai yang valid adalah "normal" dan "high". Di iOS, ini sesuai dengan prioritas APN 5 dan 10 .

Secara default, pesan notifikasi dikirim dengan prioritas tinggi, dan pesan data dikirim dengan prioritas normal. Prioritas normal mengoptimalkan konsumsi baterai aplikasi klien dan harus digunakan kecuali diperlukan pengiriman segera. Untuk pesan dengan prioritas normal, aplikasi mungkin menerima pesan dengan penundaan yang tidak ditentukan.

Ketika pesan dikirim dengan prioritas tinggi, pesan tersebut segera dikirim, dan aplikasi dapat membangunkan perangkat yang sedang tidur dan membuka koneksi jaringan ke server Anda.

Untuk informasi lebih lanjut, lihat Mengatur prioritas pesan .

**Nilai default:** "high" untuk pesan notifikasi, "normal" untuk pesan data

Tanda tangan:

priority?: string;

MessagingOptions.restrictedPackageName

Nama paket aplikasi yang token registrasinya harus cocok untuk menerima pesan.

**Nilai default:** Tidak ada

Tanda tangan:

restrictedPackageName?: string;

MessagingOptions.timeToLive

Berapa lama (dalam detik) pesan harus disimpan di penyimpanan FCM jika perangkat sedang offline. Waktu maksimum untuk hidup yang didukung adalah empat minggu, dan nilai defaultnya juga empat minggu. Untuk informasi lebih lanjut, lihat Mengatur masa pakai pesan .

**Nilai default:** 2419200 (mewakili empat minggu, dalam hitungan detik)

Tanda tangan:

timeToLive?: number;