รับข้อความโดยใช้ Firebase Cloud Messaging

คู่มือนี้อธิบายวิธีตั้งค่า Firebase Cloud Messaging ในแอปไคลเอ็นต์บนอุปกรณ์เคลื่อนที่และเว็บ เพื่อให้คุณรับข้อความได้อย่างน่าเชื่อถือ

เมื่อติดตั้งแอปไคลเอ็นต์ในอุปกรณ์แล้ว แอปจะรับข้อความผ่าน FCMอินเทอร์เฟซ APNs ได้ คุณสามารถเริ่มส่งการแจ้งเตือนไปยังกลุ่มผู้ใช้ได้ทันทีด้วยเครื่องมือแต่งการแจ้งเตือน หรือข้อความที่สร้างในเซิร์ฟเวอร์แอปพลิเคชัน

จัดการการแจ้งเตือน

FCM จะส่งข้อความทั้งหมดที่กำหนดเป้าหมายไปยังแอปของ Apple ผ่าน APNs ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับการแจ้งเตือน APNs โดยใช้ UNUserNotificationCenter ได้ที่เอกสารประกอบของ Apple เกี่ยวกับการจัดการการแจ้งเตือนและการดำเนินการที่เกี่ยวข้องกับการแจ้งเตือน

คุณต้องตั้งค่า ผู้มอบสิทธิ์ UNUserNotificationCenter และใช้เมธอดผู้มอบสิทธิ์ที่เหมาะสมเพื่อรับการแจ้งเตือนที่แสดง จาก FCM

Swift 

// Receive displayed notifications for iOS 10+ devices.
func userNotificationCenter(_ center: UNUserNotificationCenter,
                            willPresent notification: UNNotification) async
  -> UNNotificationPresentationOptions {
  let userInfo = notification.request.content.userInfo

  // With swizzling disabled you must let Messaging know about the message, for Analytics
  // Messaging.messaging().appDidReceiveMessage(userInfo)

  // ...

  // Print full message.
  print(userInfo)

  // Change this to your preferred presentation option
  // Note: UNNotificationPresentationOptions.alert has been deprecated.
  return [.list, .banner, .sound]
}

func userNotificationCenter(_ center: UNUserNotificationCenter,
                            didReceive response: UNNotificationResponse) async {
  let userInfo = response.notification.request.content.userInfo

  // ...

  // Print full message.
  print(userInfo)
}
MigratedSnippets.swift

Objective-C 

// Receive displayed notifications for iOS 10+ devices.
// Handle incoming notification messages while app is in the foreground.
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
       willPresentNotification:(UNNotification *)notification
         withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
  NSDictionary *userInfo = notification.request.content.userInfo;

  // With swizzling disabled you must let Messaging know about the message, for Analytics
  // [[FIRMessaging messaging] appDidReceiveMessage:userInfo];

  // Print full message.
  NSLog(@"%@", userInfo);

  // Change this to your preferred presentation option
  completionHandler(UNNotificationPresentationOptionList |
                    UNNotificationPresentationOptionBanner |
                    UNNotificationPresentationOptionSound);
}

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
    NSLog(@"FCM registration token: %@", fcmToken);
    // Notify about received token.
    NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"];
    [[NSNotificationCenter defaultCenter] postNotificationName:
     @"FCMToken" object:nil userInfo:dataDict];
    // TODO: If necessary send token to application server.
    // Note: This callback is fired at each app startup and whenever a new token is generated.
}

- (void)logFCMToken {
  NSString *fcmToken = [FIRMessaging messaging].FCMToken;
  NSLog(@"Local FCM registration token: %@", fcmToken);

  NSString* displayToken = [NSString stringWithFormat:@"Logged FCM token: %@", fcmToken];

  [[FIRMessaging messaging] tokenWithCompletion:^(NSString * _Nullable token, NSError * _Nullable error) {
    if (error != nil) {
      NSLog(@"Error fetching the remote FCM registration token: %@", error);
    } else {
      NSLog(@"Remote FCM registration token: %@", token);
      NSString* message =
        [NSString stringWithFormat:@"FCM registration token: %@", token];
      // display message
      NSLog(@"%@", message);
    }
  }];
  NSLog(@"%@", displayToken);
}

- (void)subsribeToTopic {
  [[FIRMessaging messaging] subscribeToTopic:@"weather"
                                  completion:^(NSError * _Nullable error) {
    NSLog(@"Subscribed to weather topic");
  }];
}

@end

ObjCMigratedSnippets.m

หากต้องการเพิ่มการดำเนินการที่กำหนดเองในการแจ้งเตือน ให้ตั้งค่าพารามิเตอร์ click_action ในเพย์โหลดการแจ้งเตือน ใช้ค่าที่คุณจะใช้สำหรับคีย์ category ในเพย์โหลด APNs คุณต้องลงทะเบียนการดำเนินการที่กำหนดเองก่อนจึงจะใช้งานได้ ดูข้อมูลเพิ่มเติมได้ในคู่มือการเขียนโปรแกรมการแจ้งเตือนในเครื่องและระยะไกลของ Apple

ดูข้อมูลเชิงลึกเกี่ยวกับการนำส่งข้อความไปยังแอปได้ใน FCMแดชบอร์ดการรายงาน ซึ่งบันทึก จำนวนข้อความที่ส่งและเปิดในอุปกรณ์ Apple และ Android พร้อมกับ ข้อมูล "การแสดงผล" (การแจ้งเตือนที่ผู้ใช้เห็น) สำหรับแอป Android

จัดการข้อความ Push แบบปิดเสียง

เมื่อส่งข้อความด้วยคีย์ content-available (เทียบเท่ากับ content-available ของ APNs) ระบบจะส่งข้อความเป็นการแจ้งเตือนแบบเงียบ ซึ่งจะเปิดแอปในเบื้องหลังสำหรับงานต่างๆ เช่น การรีเฟรชข้อมูลในเบื้องหลัง การแจ้งเตือนเหล่านี้ต้องได้รับการจัดการโดยใช้เมธอด application(_:didReceiveRemoteNotification:fetchCompletionHandler:) ซึ่งแตกต่างจากการแจ้งเตือนที่ทำงานในเบื้องหน้า

ใช้ application(_:didReceiveRemoteNotification:fetchCompletionHandler:) ตามที่แสดง

Swift

@MainActor
func application(_ application: UIApplication,
                 didReceiveRemoteNotification userInfo: [AnyHashable: Any]) async
  -> UIBackgroundFetchResult {
  // If you are receiving a notification message while your app is in the background,
  // this callback will not be fired till the user taps on the notification launching the application.
  // TODO: Handle data of notification

  // With swizzling disabled you must let Messaging know about the message, for Analytics
  // Messaging.messaging().appDidReceiveMessage(userInfo)

  // ...

  // Print full message.
  print(userInfo)
  print("Call exportDeliveryMetricsToBigQuery() from AppDelegate")
  Messaging.serviceExtension().exportDeliveryMetricsToBigQuery(withMessageInfo: userInfo)
  return UIBackgroundFetchResult.newData
}
MigratedSnippets.swift

Objective-C

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
    fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
  // If you are receiving a notification message while your app is in the background,
  // this callback will not be fired until the user taps on the notification launching the application.
  // TODO: Handle data of notification

  // With swizzling disabled you must let Messaging know about the message, for Analytics
  // [[FIRMessaging messaging] appDidReceiveMessage:userInfo];

  // Print full message.
  NSLog(@"%@", userInfo);

  completionHandler(UIBackgroundFetchResultNewData);
}
ObjCMigratedSnippets.m

แพลตฟอร์มของ Apple ไม่รับประกันการนำส่งการแจ้งเตือนในเบื้องหลัง หากต้องการดูข้อมูลเกี่ยวกับเงื่อนไขที่อาจทำให้การแจ้งเตือนในเบื้องหลังล้มเหลว โปรดดูเอกสารของ Apple เกี่ยวกับการพุชการอัปเดตในเบื้องหลังไปยังแอป

ตีความเพย์โหลดข้อความการแจ้งเตือน

เพย์โหลดของข้อความการแจ้งเตือนคือพจนานุกรมของคีย์และค่า ข้อความแจ้งเตือนที่ส่งผ่าน APNs จะมีรูปแบบเพย์โหลด APNs ดังนี้

  {
    "aps" : {
      "alert" : {
        "body" : "great match!",
        "title" : "Portugal vs. Denmark",
      },
      "badge" : 1,
    },
    "customKey" : "customValue"
  }

จัดการข้อความโดยปิดใช้การสลับเมธอด

โดยค่าเริ่มต้น หากคุณกำหนดคลาส App Delegate ของแอปให้กับพร็อพเพอร์ตี้ Delegate ของ UNUserNotificationCenter และ Messaging FCM จะสลับคลาส App Delegate ของแอปเพื่อเชื่อมโยงโทเค็น FCM โดยอัตโนมัติกับโทเค็น APNs ของอุปกรณ์ และส่งเหตุการณ์การแจ้งเตือนที่ได้รับไปยัง Analytics หากปิดใช้การสลับเมธอดอย่างชัดเจน หากคุณสร้างแอป SwiftUI หรือหากใช้คลาสแยกต่างหากสำหรับผู้รับมอบสิทธิ์ คุณจะต้องดำเนินการทั้ง 2 อย่างนี้ด้วยตนเอง

หากต้องการเชื่อมโยงโทเค็น FCM กับโทเค็น APNs ของอุปกรณ์ ให้ส่งโทเค็น APNs ไปยังคลาส Messaging ในตัวแฮนเดิลการรีเฟรชโทเค็นของตัวแทนแอป โดยใช้พร็อพเพอร์ตี้ apnsToken

Swift

func application(_ application: UIApplication,
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
  Messaging.messaging().apnsToken = deviceToken;
}

Objective-C

- (void)application:(UIApplication *)application
    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
  [FIRMessaging messaging].APNSToken = deviceToken;
}

หากต้องการส่งข้อมูลการรับการแจ้งเตือนไปยัง Analytics ให้ใช้appDidReceiveMessage(_:) เมธอด

Swift

func userNotificationCenter(_ center: UNUserNotificationCenter,
                            willPresent notification: UNNotification,
  withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  let userInfo = notification.request.content.userInfo

  Messaging.messaging().appDidReceiveMessage(userInfo)

  // Change this to your preferred presentation option
  completionHandler([[.alert, .sound]])
}

func userNotificationCenter(_ center: UNUserNotificationCenter,
                            didReceive response: UNNotificationResponse,
                            withCompletionHandler completionHandler: @escaping () -> Void) {
  let userInfo = response.notification.request.content.userInfo

  Messaging.messaging().appDidReceiveMessage(userInfo)

  completionHandler()
}

func application(_ application: UIApplication,
didReceiveRemoteNotification userInfo: [AnyHashable : Any],
  fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
  Messaging.messaging().appDidReceiveMessage(userInfo)
  completionHandler(.noData)
}

Objective-C

- (void)userNotificationCenter:(UNUserNotificationCenter *)center
      willPresentNotification:(UNNotification *)notification
        withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
  NSDictionary *userInfo = notification.request.content.userInfo;

  [[FIRMessaging messaging] appDidReceiveMessage:userInfo];

  // Change this to your preferred presentation option
  completionHandler(UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionAlert);
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center
didReceiveNotificationResponse:(UNNotificationResponse *)response
        withCompletionHandler:(void(^)(void))completionHandler {
  NSDictionary *userInfo = response.notification.request.content.userInfo;

  [[FIRMessaging messaging] appDidReceiveMessage:userInfo];

  completionHandler();
}

- (void)application:(UIApplication *)application
didReceiveRemoteNotification:(NSDictionary *)userInfo
fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
  [[FIRMessaging messaging] appDidReceiveMessage:userInfo];
  completionHandler(UIBackgroundFetchResultNoData);
}