Antarmuka yang merepresentasikan opsi yang dapat diberikan ketika mengirim pesan melalui API lama FCM.
Lihat Membangun permintaan kirim untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
export interface MessagingOptions
Properti
| Properti | Jenis | Deskripsi |
|---|---|---|
| ciutkanKey | string | String yang mengidentifikasi grup pesan (misalnya, "Update Tersedia") yang dapat diciutkan, sehingga hanya pesan terakhir yang akan dikirim saat pengiriman dapat dilanjutkan. Hal ini digunakan untuk menghindari pengiriman terlalu banyak pesan yang sama saat perangkat kembali online atau menjadi aktif.Tidak ada jaminan terkait urutan pesan yang akan dikirim.Maksimal empat kunci penciutan berbeda diizinkan pada waktu tertentu. Artinya, server FCM bisa secara bersamaan menyimpan empat pesan kirim-untuk-sinkronisasi yang berbeda per aplikasi klien. Jika Anda melampaui angka ini, tidak ada jaminan manakah empat kunci penciutan yang akan disimpan oleh server FCM.**Nilai default:** Tidak ada |
| contentTersedia | boolean | Di iOS, gunakan kolom ini untuk mewakili content-available dalam payload APN. Ketika notifikasi atau pesan data dikirim dan disetel ke true, aplikasi klien yang tidak aktif akan diaktifkan. Pada Android, pesan data akan membangunkan aplikasi secara default. Di Chrome, flag ini saat ini tidak didukung.**Nilai default:** false |
| dryRun | boolean | Apakah pesan harus benar-benar dikirim. Jika ditetapkan ke true, developer akan dapat menguji permintaan tanpa benar-benar mengirim pesan. Jika disetel ke false, pesan akan dikirim.**Nilai default:** false |
| mutableContent | boolean | Di iOS, gunakan kolom ini untuk mewakili mutable-content dalam payload APN. Jika notifikasi dikirim dan ini disetel ke true, isi notifikasi dapat diubah sebelum ditampilkan, menggunakan ekstensi aplikasi Layanan Notifikasi.Di Android dan Web, parameter ini akan diabaikan.**Nilai default:** false |
| prioritas | string | Prioritas pesan. Nilai yang valid adalah "normal" dan "high". Di iOS, keduanya sama 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 jika diperlukan pengiriman dengan segera. Untuk pesan dengan prioritas normal, aplikasi mungkin menerima pesan dengan penundaan yang tidak ditentukan.Jika pesan dikirim dengan prioritas tinggi, pesan akan segera dikirim, dan aplikasi bisa membangunkan perangkat yang sedang tidur serta membuka koneksi jaringan ke server.Untuk informasi selengkapnya, lihat Menetapkan prioritas pesan.**Nilai default:** "high" untuk pesan notifikasi, "normal" untuk pesan data |
| restrictedPackageName | string | Nama paket aplikasi yang harus cocok dengan token pendaftaran agar bisa menerima pesan.**Nilai default:** Tidak ada |
| timeToLive | angka | Durasi (dalam detik) pesan harus disimpan dalam penyimpanan FCM jika perangkat sedang offline. Waktu aktif maksimum yang didukung adalah empat minggu, dan nilai defaultnya juga empat minggu. Untuk informasi selengkapnya, lihat Menyetel masa aktif pesan.**Nilai default:** 2419200 (dalam detik) |
MessagingOptions.ciutkanKey
String yang mengidentifikasi grup pesan (misalnya, "Update Tersedia") yang dapat diciutkan, sehingga hanya pesan terakhir yang akan dikirim saat pengiriman dapat dilanjutkan. Hal ini digunakan untuk menghindari pengiriman terlalu banyak pesan yang sama saat perangkat kembali online atau aktif.
Tidak ada jaminan untuk urutan pesan yang akan dikirim.
Maksimum empat kunci penciutan berbeda yang diizinkan pada waktu tertentu. Artinya, server FCM bisa secara bersamaan menyimpan empat pesan kirim-untuk-sinkronisasi yang berbeda per aplikasi klien. Jika Anda melampaui angka ini, tidak ada jaminan manakah empat kunci penciutan ini 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 dalam payload APN. Ketika notifikasi atau pesan data dikirim dan disetel ke true, aplikasi klien yang tidak aktif akan diaktifkan. Pada Android, pesan data akan membangunkan aplikasi secara default. Di Chrome, tanda ini saat ini tidak didukung.
**Nilai default:** false
Tanda Tangan:
contentAvailable?: boolean;
MessagingOptions.dryRun
Apakah pesan harus benar-benar dikirim. Jika ditetapkan ke true, developer akan dapat menguji permintaan tanpa benar-benar mengirim pesan. Jika ditetapkan ke false, pesan akan dikirim.
**Nilai default:** false
Tanda Tangan:
dryRun?: boolean;
MessagingOptions.mutableContent
Di iOS, gunakan kolom ini untuk mewakili mutable-content dalam payload APN. Saat notifikasi dikirim dan disetel ke true, isi 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.priority
Prioritas pesan. Nilai yang valid adalah "normal" dan "high". Di iOS, keduanya sama 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 jika diperlukan pengiriman dengan segera. Untuk pesan dengan prioritas normal, aplikasi bisa menerima pesan dengan penundaan yang tidak ditetapkan.
Jika dikirim dengan prioritas tinggi, pesan akan dikirim dengan segera, dan aplikasi bisa membangunkan perangkat yang sedang tidur serta membuka koneksi jaringan ke server Anda.
Untuk mengetahui informasi lebih lanjut, lihat Menyetel prioritas pesan.
**Nilai default:** "high" untuk pesan notifikasi, "normal" untuk pesan data
Tanda Tangan:
priority?: string;
MessagingOptions.restrictedPackageName
Nama paket aplikasi yang harus cocok dengan token pendaftaran agar bisa menerima pesan.
**Nilai default:** Tidak ada
Tanda Tangan:
restrictedPackageName?: string;
MessagingOptions.timeToLive
Durasi (dalam detik) pesan harus disimpan dalam penyimpanan FCM jika perangkat sedang offline. Waktu aktif maksimum yang didukung adalah empat minggu, dan nilai defaultnya juga empat minggu. Untuk mengetahui informasi selengkapnya, lihat Menyetel masa aktif pesan.
**Nilai default:** 2419200 (mewakili empat minggu, dalam detik)
Tanda Tangan:
timeToLive?: number;