แสดงถึงตัวเลือกการแจ้งเตือนเฉพาะของ Android ที่สามารถรวมอยู่ใน AndroidConfig .
ลายเซ็น:
export interface AndroidNotification
คุณสมบัติ
คุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ร่างกาย | เชือก | เนื้อหาของการแจ้งเตือน Android เมื่อระบุไว้ ให้แทนที่เนื้อหาที่ตั้งค่าไว้ผ่าน admin.messaging.Notification |
bodyLocArgs | สตริง[] | อาร์เรย์ของคีย์ทรัพยากรที่จะใช้แทนตัวระบุรูปแบบใน bodyLocKey |
บอดี้ล็อคคีย์ | เชือก | คีย์ของสตริงเนื้อหาในทรัพยากรสตริงของแอปเพื่อใช้แปลข้อความเนื้อหา |
รหัสช่อง | เชือก | รหัสช่องทางการแจ้งเตือนของ Android (ใหม่ใน Android O) แอปต้องสร้างช่องด้วยรหัสช่องนี้ก่อนจึงจะสามารถรับการแจ้งเตือนด้วยรหัสช่องนี้ได้ หากคุณไม่ส่งรหัสช่องนี้ในคำขอ หรือหากแอปยังไม่ได้สร้างรหัสช่องที่ระบุ FCM จะใช้รหัสช่องที่ระบุในรายการแอป |
คลิกการกระทำ | เชือก | การดำเนินการที่เกี่ยวข้องกับการคลิกของผู้ใช้ในการแจ้งเตือน หากระบุไว้ กิจกรรมที่มีตัวกรองเจตนาที่ตรงกันจะถูกเปิดใช้งานเมื่อผู้ใช้คลิกที่การแจ้งเตือน |
สี | เชือก | สีไอคอนการแจ้งเตือนในรูปแบบ #rrggbb |
การตั้งค่าเริ่มต้น LightSettings | บูลีน | หากตั้งค่าเป็น true ให้ใช้การตั้งค่าไฟ LED เริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml . หากตั้ง default_light_settings เป็น true และตั้ง light_settings ด้วย light_settings ที่ผู้ใช้ระบุจะถูกใช้แทนค่าเริ่มต้น |
ค่าเริ่มต้นเสียง | บูลีน | หากตั้งค่าเป็น true ให้ใช้เสียงเริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml . |
ค่าเริ่มต้นสั่นกำหนดเวลา | บูลีน | หากตั้งค่าเป็น true ให้ใช้รูปแบบการสั่นเริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml . หากตั้ง default_vibrate_timings เป็น true และตั้ง vibrate_timings ไว้ด้วย ระบบจะใช้ค่าเริ่มต้นแทน vibrate_timings ที่ผู้ใช้ระบุ |
เหตุการณ์ประทับเวลา | วันที่ | สำหรับการแจ้งเตือนที่แจ้งให้ผู้ใช้ทราบเกี่ยวกับเหตุการณ์ด้วยการอ้างอิงเวลาที่แน่นอน ให้ตั้งเวลาที่เหตุการณ์ในการแจ้งเตือนเกิดขึ้น การแจ้งเตือนในแผงจะจัดเรียงตามเวลานี้ |
ไอคอน | เชือก | ทรัพยากรไอคอนสำหรับการแจ้งเตือนของ Android |
imageUrl | เชือก | URL ของรูปภาพที่จะแสดงในการแจ้งเตือน |
การตั้งค่าแสง | การตั้งค่าแสง | การตั้งค่าเพื่อควบคุมอัตราการกะพริบและสีของ LED การแจ้งเตือนหากมี LED อยู่ในอุปกรณ์ เวลาการกะพริบทั้งหมดจะถูกควบคุมโดยระบบปฏิบัติการ |
ท้องถิ่นเท่านั้น | บูลีน | ตั้งค่าว่าการแจ้งเตือนนี้เกี่ยวข้องกับอุปกรณ์ปัจจุบันเท่านั้นหรือไม่ การแจ้งเตือนบางอย่างสามารถเชื่อมโยงไปยังอุปกรณ์อื่นเพื่อแสดงผลระยะไกลได้ เช่น นาฬิกา Wear OS คำแนะนำนี้สามารถตั้งค่าให้แนะนำว่าอย่าเชื่อมโยงการแจ้งเตือนนี้ ดู คำแนะนำ Wear OS . |
การแจ้งเตือนนับ | ตัวเลข | กำหนดจำนวนรายการที่การแจ้งเตือนนี้เป็นตัวแทน อาจแสดงเป็นจำนวนป้ายสำหรับ Launchers ที่รองรับการติดป้าย ดู ป้ายการแจ้งเตือน . ตัวอย่างเช่น สิ่งนี้อาจมีประโยชน์หากคุณใช้การแจ้งเตือนเดียวเพื่อแสดงข้อความใหม่หลายข้อความ แต่คุณต้องการนับที่นี่เพื่อแสดงจำนวนข้อความใหม่ทั้งหมด หากเป็นศูนย์หรือไม่ได้ระบุ ระบบที่รองรับการติดป้ายจะใช้ค่าเริ่มต้น ซึ่งก็คือการเพิ่มตัวเลขที่แสดงบนเมนูแบบกดค้างทุกครั้งที่มีการแจ้งเตือนใหม่มาถึง |
ลำดับความสำคัญ | ('ขั้นต่ำ' | 'ต่ำ' | 'ค่าเริ่มต้น' | 'สูง' | 'สูงสุด') | ตั้งค่าลำดับความสำคัญสัมพัทธ์สำหรับการแจ้งเตือนนี้ การแจ้งเตือนที่มีลำดับความสำคัญต่ำอาจถูกซ่อนไม่ให้ผู้ใช้เห็นในบางสถานการณ์ โปรดทราบว่าลำดับความสำคัญนี้แตกต่างจาก AndroidMessagePriority ลำดับความสำคัญนี้ได้รับการประมวลผลโดยไคลเอ็นต์หลังจากส่งข้อความแล้ว ในขณะที่ AndroidMessagePriority เป็นแนวคิด FCM ที่ควบคุมเวลาที่ส่งข้อความ |
เสียง | เชือก | ชื่อไฟล์เสียงที่จะเล่นเมื่ออุปกรณ์ได้รับการแจ้งเตือน |
เหนียว | บูลีน | เมื่อตั้งค่าเป็น false หรือไม่ได้ตั้งค่า การแจ้งเตือนจะถูกปิดโดยอัตโนมัติเมื่อผู้ใช้คลิกการแจ้งเตือนในแผง เมื่อตั้งค่าเป็น true การแจ้งเตือนจะยังคงอยู่แม้ว่าผู้ใช้จะคลิกก็ตาม |
แท็ก | เชือก | แท็กการแจ้งเตือน นี่คือตัวระบุที่ใช้แทนที่การแจ้งเตือนที่มีอยู่ในลิ้นชักการแจ้งเตือน หากไม่ได้ระบุ แต่ละคำขอจะสร้างการแจ้งเตือนใหม่ |
สัญลักษณ์ | เชือก | ตั้งค่าข้อความ "สัญลักษณ์" ซึ่งจะถูกส่งไปยังบริการการเข้าถึง ก่อน API ระดับ 21 (Lollipop) ให้ตั้งค่าข้อความที่จะแสดงในแถบสถานะเมื่อมีการแจ้งเตือนมาถึงครั้งแรก |
ชื่อ | เชือก | ชื่อเรื่องการแจ้งเตือนของ Android เมื่อระบุ ให้แทนที่ชื่อที่ตั้งไว้ผ่าน admin.messaging.Notification |
titleLocArgs | สตริง[] | อาร์เรย์ของคีย์ทรัพยากรที่จะใช้แทนตัวระบุรูปแบบใน titleLocKey |
titleLockKey | เชือก | คีย์ของสตริงชื่อในทรัพยากรสตริงของแอปเพื่อใช้แปลข้อความชื่อเรื่อง |
สั่น TimingsMillis | ตัวเลข[] | กำหนดรูปแบบการสั่นที่จะใช้ ส่งผ่านอาร์เรย์มิลลิวินาทีเพื่อเปิดหรือปิดเครื่องสั่น ค่าแรกระบุระยะเวลาที่ต้องรอก่อนที่จะเปิดเครื่องสั่น ค่าถัดไประบุระยะเวลาในการเปิดเครื่องสั่นไว้ ค่าที่ตามมาจะสลับระหว่างระยะเวลาในการปิดเครื่องสั่นและเพื่อเปิดเครื่องสั่น หากตั้ง vibrate_timings และ default_vibrate_timings ตั้งค่าเป็น true ระบบจะใช้ค่าเริ่มต้นแทน vibrate_timings ที่ผู้ใช้ระบุ |
ทัศนวิสัย | ('ส่วนตัว' | 'สาธารณะ' | 'ความลับ') | ตั้งค่าการเปิดเผยการแจ้งเตือน ต้องเป็น private public หรือเป็น secret หากไม่ได้ระบุ จะใช้ค่าเริ่มต้นเป็น private |
AndroidNotification.body
เนื้อหาของการแจ้งเตือน Android เมื่อระบุไว้ จะแทนที่เนื้อหาที่ตั้งค่าไว้ผ่าน admin.messaging.Notification
.
ลายเซ็น:
body?: string;
AndroidNotification.bodyLocArgs
อาร์เรย์ของคีย์ทรัพยากรที่จะใช้แทนตัวระบุรูปแบบใน bodyLocKey
.
ลายเซ็น:
bodyLocArgs?: string[];
AndroidNotification.bodyLockKey
คีย์ของสตริงเนื้อหาในทรัพยากรสตริงของแอปเพื่อใช้แปลข้อความเนื้อหา
ลายเซ็น:
bodyLocKey?: string;
AndroidNotification.channelId
รหัสช่องทางการแจ้งเตือนของ Android (ใหม่ใน Android O) แอปต้องสร้างช่องด้วยรหัสช่องนี้ก่อนจึงจะสามารถรับการแจ้งเตือนด้วยรหัสช่องนี้ได้ หากคุณไม่ส่งรหัสช่องนี้ในคำขอ หรือหากแอปยังไม่ได้สร้างรหัสช่องที่ระบุ FCM จะใช้รหัสช่องที่ระบุในรายการแอป
ลายเซ็น:
channelId?: string;
AndroidNotification.คลิกการกระทำ
การดำเนินการที่เกี่ยวข้องกับการคลิกของผู้ใช้ในการแจ้งเตือน หากระบุไว้ กิจกรรมที่มีตัวกรองเจตนาที่ตรงกันจะถูกเปิดใช้งานเมื่อผู้ใช้คลิกที่การแจ้งเตือน
ลายเซ็น:
clickAction?: string;
AndroidNotification.สี
สีไอคอนการแจ้งเตือนในรูปแบบ #rrggbb
ลายเซ็น:
color?: string;
AndroidNotification.defaultLightSettings
หากตั้งค่าเป็น true
ใช้การตั้งค่าไฟ LED เริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml . หากตั้ง default_light_settings
เป็น true
และตั้ง light_settings
ด้วย light_settings
ที่ผู้ใช้ระบุจะถูกใช้แทนค่าเริ่มต้น
ลายเซ็น:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
หากตั้งค่าเป็น true
ให้ใช้เสียงเริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml .
ลายเซ็น:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
หากตั้งค่าเป็น true
ให้ใช้รูปแบบการสั่นเริ่มต้นของเฟรมเวิร์ก Android สำหรับการแจ้งเตือน ค่าเริ่มต้นระบุไว้ใน config.xml . หากตั้ง default_vibrate_timings
เป็น true
และตั้ง vibrate_timings
ไว้ด้วย ระบบจะใช้ค่าเริ่มต้นแทน vibrate_timings
ที่ผู้ใช้ระบุ .
ลายเซ็น:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
สำหรับการแจ้งเตือนที่แจ้งให้ผู้ใช้ทราบเกี่ยวกับเหตุการณ์ด้วยการอ้างอิงเวลาที่แน่นอน ให้ตั้งเวลาที่เหตุการณ์ในการแจ้งเตือนเกิดขึ้น การแจ้งเตือนในแผงจะจัดเรียงตามเวลานี้
ลายเซ็น:
eventTimestamp?: Date;
AndroidNotification.ไอคอน
ทรัพยากรไอคอนสำหรับการแจ้งเตือนของ Android
ลายเซ็น:
icon?: string;
AndroidNotification.imageUrl
URL ของรูปภาพที่จะแสดงในการแจ้งเตือน
ลายเซ็น:
imageUrl?: string;
AndroidNotification.lightSettings
การตั้งค่าเพื่อควบคุมอัตราการกะพริบและสีของ LED การแจ้งเตือนหากมี LED อยู่ในอุปกรณ์ เวลาการกะพริบทั้งหมดจะถูกควบคุมโดยระบบปฏิบัติการ
ลายเซ็น:
lightSettings?: LightSettings;
AndroidNotification.localOnly
ตั้งค่าว่าการแจ้งเตือนนี้เกี่ยวข้องกับอุปกรณ์ปัจจุบันเท่านั้นหรือไม่ การแจ้งเตือนบางอย่างสามารถเชื่อมโยงไปยังอุปกรณ์อื่นเพื่อแสดงผลระยะไกลได้ เช่น นาฬิกา Wear OS คำแนะนำนี้สามารถตั้งค่าให้แนะนำว่าอย่าเชื่อมโยงการแจ้งเตือนนี้ ดู คำแนะนำ Wear OS .
ลายเซ็น:
localOnly?: boolean;
AndroidNotification.notificationCount
กำหนดจำนวนรายการที่การแจ้งเตือนนี้เป็นตัวแทน อาจแสดงเป็นจำนวนป้ายสำหรับ Launchers ที่รองรับการติดป้าย ดู ป้ายการแจ้งเตือน . ตัวอย่างเช่น สิ่งนี้อาจมีประโยชน์หากคุณใช้การแจ้งเตือนเดียวเพื่อแสดงข้อความใหม่หลายข้อความ แต่คุณต้องการนับที่นี่เพื่อแสดงจำนวนข้อความใหม่ทั้งหมด หากเป็นศูนย์หรือไม่ได้ระบุ ระบบที่รองรับการติดป้ายจะใช้ค่าเริ่มต้น ซึ่งก็คือการเพิ่มตัวเลขที่แสดงบนเมนูแบบกดค้างทุกครั้งที่มีการแจ้งเตือนใหม่มาถึง
ลายเซ็น:
notificationCount?: number;
AndroidNotification.priority
ตั้งค่าลำดับความสำคัญสัมพัทธ์สำหรับการแจ้งเตือนนี้ การแจ้งเตือนที่มีลำดับความสำคัญต่ำอาจถูกซ่อนไม่ให้ผู้ใช้เห็นในบางสถานการณ์ โปรดทราบว่าลำดับความสำคัญนี้แตกต่างจาก AndroidMessagePriority
. ลำดับความสำคัญนี้ได้รับการประมวลผลโดยไคลเอ็นต์หลังจากส่งข้อความแล้ว ในขณะที่ AndroidMessagePriority
เป็นแนวคิด FCM ที่ควบคุมเวลาที่ส่งข้อความ
ลายเซ็น:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotification.sound
ชื่อไฟล์เสียงที่จะเล่นเมื่ออุปกรณ์ได้รับการแจ้งเตือน
ลายเซ็น:
sound?: string;
AndroidNotification.เหนียว
เมื่อตั้งค่าเป็น false
หรือไม่ได้ตั้งค่า การแจ้งเตือนจะถูกปิดโดยอัตโนมัติเมื่อผู้ใช้คลิกการแจ้งเตือนในแผง เมื่อตั้งค่าเป็น true
การแจ้งเตือนจะยังคงอยู่แม้ว่าผู้ใช้จะคลิกก็ตาม
ลายเซ็น:
sticky?: boolean;
AndroidNotification.tag
แท็กการแจ้งเตือน นี่คือตัวระบุที่ใช้แทนที่การแจ้งเตือนที่มีอยู่ในลิ้นชักการแจ้งเตือน หากไม่ได้ระบุ แต่ละคำขอจะสร้างการแจ้งเตือนใหม่
ลายเซ็น:
tag?: string;
AndroidNotification.ticker
ตั้งค่าข้อความ "สัญลักษณ์" ซึ่งจะถูกส่งไปยังบริการการเข้าถึง ก่อน API ระดับ 21 (Lollipop) ให้ตั้งค่าข้อความที่จะแสดงในแถบสถานะเมื่อมีการแจ้งเตือนมาถึงครั้งแรก
ลายเซ็น:
ticker?: string;
AndroidNotification.title
ชื่อเรื่องการแจ้งเตือนของ Android เมื่อระบุ ให้แทนที่ชื่อที่ตั้งไว้ผ่าน admin.messaging.Notification
.
ลายเซ็น:
title?: string;
AndroidNotification.titleLocArgs
อาร์เรย์ของคีย์ทรัพยากรที่จะใช้แทนตัวระบุรูปแบบใน titleLocKey
.
ลายเซ็น:
titleLocArgs?: string[];
AndroidNotification.titleLockKey
คีย์ของสตริงชื่อในทรัพยากรสตริงของแอปเพื่อใช้แปลข้อความชื่อเรื่อง
ลายเซ็น:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
กำหนดรูปแบบการสั่นที่จะใช้ ส่งผ่านอาร์เรย์มิลลิวินาทีเพื่อเปิดหรือปิดเครื่องสั่น ค่าแรกระบุระยะเวลาที่ต้องรอก่อนที่จะเปิดเครื่องสั่น ค่าถัดไประบุระยะเวลาในการเปิดเครื่องสั่นไว้ ค่าที่ตามมาจะสลับระหว่างระยะเวลาในการปิดเครื่องสั่นและเพื่อเปิดเครื่องสั่น หากตั้ง vibrate_timings
และ default_vibrate_timings
ตั้งค่าเป็น true
ระบบจะใช้ค่าเริ่มต้นแทน vibrate_timings
ที่ผู้ใช้ระบุ .
ลายเซ็น:
vibrateTimingsMillis?: number[];
AndroidNotification.การมองเห็น
ตั้งค่าการเปิดเผยการแจ้งเตือน ต้องเป็น private
ด้วย , public
หรือ secret
. หากไม่ได้ระบุ จะใช้ค่าเริ่มต้นเป็น private
.
ลายเซ็น:
visibility?: ('private' | 'public' | 'secret');