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