MessagingOptions interface

واجهة تمثل الخيارات التي يمكن توفيرها عند إرسال رسالة عبر واجهات برمجة تطبيقات FCM القديمة.

راجع إنشاء طلبات الإرسال للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.

إمضاء:

export interface MessagingOptions 

ملكيات

ملكية يكتب وصف
CollapteKey خيط سلسلة تحدد مجموعة من الرسائل (على سبيل المثال، "التحديثات المتاحة") التي يمكن طيها، بحيث يتم إرسال الرسالة الأخيرة فقط عندما يمكن استئناف التسليم. يُستخدم هذا لتجنب إرسال عدد كبير جدًا من الرسائل نفسها عندما يعود الجهاز متصلاً بالإنترنت أو يصبح نشطًا. ليس هناك ضمان للترتيب الذي يتم به إرسال الرسائل. يُسمح بحد أقصى بأربعة مفاتيح طي مختلفة في أي وقت. وهذا يعني أن خادم FCM يمكنه تخزين أربع رسائل إرسال للمزامنة مختلفة في وقت واحد لكل تطبيق عميل. إذا تجاوزت هذا الرقم، فليس هناك ضمان بشأن المفاتيح الأربعة التي سيحتفظ بها خادم FCM. **القيمة الافتراضية:** لا شيء
المحتوى متاح منطقية في نظام التشغيل iOS، استخدم هذا الحقل لتمثيل content-available في حمولة APNs. عند إرسال إشعار أو رسالة بيانات وتعيين هذا على true ، يتم إيقاظ تطبيق العميل غير النشط. على نظام Android، تعمل رسائل البيانات على تنشيط التطبيق افتراضيًا. في Chrome، هذه العلامة غير مدعومة حاليًا. **القيمة الافتراضية:** false
ركض جاف منطقية ما إذا كان يجب إرسال الرسالة بالفعل أم لا. عند التعيين على true ، يسمح للمطورين باختبار الطلب دون إرسال رسالة فعليًا. عند التعيين على false ، سيتم إرسال الرسالة. **القيمة الافتراضية:** false
MutableContent منطقية في نظام التشغيل iOS، استخدم هذا الحقل لتمثيل mutable-content في حمولة APNs. عند إرسال إشعار وتعيين هذا على true ، يمكن تعديل محتوى الإشعار قبل عرضه، باستخدام ملحق تطبيق خدمة الإشعارات . على Android والويب، سيتم تجاهل هذه المعلمة. **القيمة الافتراضية:** false
أولوية خيط أولوية الرسالة. القيم الصالحة هي "normal" و "high". على نظام التشغيل iOS، تتوافق هذه مع أولويات APN 5 و 10 . افتراضيًا، يتم إرسال رسائل الإعلام بأولوية عالية، ويتم إرسال رسائل البيانات بأولوية عادية. تعمل الأولوية العادية على تحسين استهلاك بطارية تطبيق العميل ويجب استخدامها ما لم يكن التسليم الفوري مطلوبًا. بالنسبة للرسائل ذات الأولوية العادية، قد يتلقى التطبيق الرسالة بتأخير غير محدد. عندما يتم إرسال رسالة ذات أولوية عالية، يتم إرسالها على الفور، ويمكن للتطبيق تنبيه جهاز نائم وفتح اتصال شبكة بالخادم الخاص بك. لمزيد من المعلومات، راجع تحديد أولوية الرسالة . **القيمة الافتراضية:** "high" لرسائل الإشعارات، "normal" لرسائل البيانات
اسم الحزمة المقيد خيط اسم حزمة التطبيق الذي يجب أن تتطابق معه رموز التسجيل لتلقي الرسالة. **القيمة الافتراضية:** لا شيء
com.timeToLive رقم المدة (بالثواني) التي يجب أن تبقى فيها الرسالة في وحدة تخزين FCM إذا كان الجهاز غير متصل بالإنترنت. الحد الأقصى لوقت الدعم هو أربعة أسابيع، والقيمة الافتراضية هي أيضًا أربعة أسابيع. لمزيد من المعلومات، راجع ضبط مدة الرسالة . **القيمة الافتراضية:** 2419200 (تمثل أربعة أسابيع، بالثواني)

خيارات المراسلة.collapseKey

سلسلة تحدد مجموعة من الرسائل (على سبيل المثال، "التحديثات المتاحة") التي يمكن طيها، بحيث يتم إرسال الرسالة الأخيرة فقط عندما يمكن استئناف التسليم. يُستخدم هذا لتجنب إرسال عدد كبير جدًا من الرسائل نفسها عندما يعود الجهاز متصلاً بالإنترنت أو يصبح نشطًا.

ليس هناك ضمان للترتيب الذي يتم به إرسال الرسائل.

يُسمح بحد أقصى بأربعة مفاتيح طي مختلفة في أي وقت. وهذا يعني أن خادم FCM يمكنه تخزين أربع رسائل إرسال للمزامنة مختلفة في وقت واحد لكل تطبيق عميل. إذا تجاوزت هذا الرقم، فليس هناك ضمان بشأن المفاتيح الأربعة التي سيحتفظ بها خادم FCM.

**القيمة الافتراضية:** لا شيء

إمضاء:

collapseKey?: string;

خيارات المراسلة.المحتوى متاح

في نظام التشغيل iOS، استخدم هذا الحقل لتمثيل content-available في حمولة APNs. عندما يتم إرسال إشعار أو رسالة بيانات ويتم ضبط ذلك على true . ، يتم تنشيط تطبيق العميل غير النشط. على نظام Android، تعمل رسائل البيانات على تنشيط التطبيق افتراضيًا. في Chrome، هذه العلامة غير مدعومة حاليًا.

**القيمة الافتراضية:** false

إمضاء:

contentAvailable?: boolean;

خيارات المراسلة.dryRun

ما إذا كان يجب إرسال الرسالة بالفعل أم لا. عند التعيين على true ، يسمح للمطورين باختبار الطلب دون إرسال رسالة فعليًا. عند التعيين على false ، سيتم إرسال الرسالة.

**القيمة الافتراضية:** false

إمضاء:

dryRun?: boolean;

MessagingOptions.mutableContent

في نظام التشغيل iOS، استخدم هذا الحقل لتمثيل mutable-content في حمولة APNs. عندما يتم إرسال إشعار ويتم ضبط هذا على true . ، يمكن تعديل محتوى الإشعار قبل عرضه، باستخدام ملحق تطبيق خدمة الإشعارات .

على Android والويب، سيتم تجاهل هذه المعلمة.

**القيمة الافتراضية:** false

إمضاء:

mutableContent?: boolean;

خيارات المراسلة.الأولوية

أولوية الرسالة. القيم الصالحة هي "normal" و "high". على نظام التشغيل iOS، تتوافق هذه مع أولويات APN 5 و 10 .

افتراضيًا، يتم إرسال رسائل الإعلام بأولوية عالية، ويتم إرسال رسائل البيانات بأولوية عادية. تعمل الأولوية العادية على تحسين استهلاك بطارية تطبيق العميل ويجب استخدامها ما لم يكن التسليم الفوري مطلوبًا. بالنسبة للرسائل ذات الأولوية العادية، قد يتلقى التطبيق الرسالة بتأخير غير محدد.

عندما يتم إرسال رسالة ذات أولوية عالية، يتم إرسالها على الفور، ويمكن للتطبيق تنبيه جهاز نائم وفتح اتصال شبكة بالخادم الخاص بك.

لمزيد من المعلومات، راجع تحديد أولوية الرسالة .

**القيمة الافتراضية:** "high" لرسائل الإشعارات، "normal" لرسائل البيانات

إمضاء:

priority?: string;

MessagingOptions.restrictedPackageName

اسم حزمة التطبيق الذي يجب أن تتطابق معه رموز التسجيل لتلقي الرسالة.

**القيمة الافتراضية:** لا شيء

إمضاء:

restrictedPackageName?: string;

خيارات المراسلة.timeToLive

المدة (بالثواني) التي يجب أن تبقى فيها الرسالة في وحدة تخزين FCM إذا كان الجهاز غير متصل بالإنترنت. الحد الأقصى لوقت الدعم هو أربعة أسابيع، والقيمة الافتراضية هي أيضًا أربعة أسابيع. لمزيد من المعلومات، راجع ضبط مدة الرسالة .

**القيمة الافتراضية:** 2419200 (تمثل أربعة أسابيع، بالثواني)

إمضاء:

timeToLive?: number;