קבלת הודעות באמצעות העברת הודעות בענן ב-Firebase

במדריך הזה מוסבר איך להגדיר את Firebase Cloud Messaging באפליקציות הלקוח לנייד ולאינטרנט כדי לקבל הודעות בצורה מהימנה.

אחרי שאפליקציית הלקוח מותקנת במכשיר, היא יכולה לקבל הודעות דרך ממשק ה-APNs של FCM. אתם יכולים להתחיל לשלוח התראות לפלחי משתמשים באופן מיידי באמצעות כלי ההתראות, או הודעות שנוצרו בשרת האפליקציה.

איך מטפלים בהתראות

FCM מעביר את כל ההודעות שמיועדות לאפליקציות של אפל דרך APNs. מידע נוסף על קבלת התראות APNs באמצעות UNUserNotificationCenter זמין במסמכי התיעוד של Apple בנושא טיפול בהתראות ובפעולות שקשורות להתראות.

כדי לקבל התראות שמוצגות מ-FCM, צריך להגדיר את הנציג של UNUserNotificationCenter ולהטמיע את שיטות הנציג המתאימות.

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)
}

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

אם רוצים להוסיף פעולות מותאמות אישית להתראות, צריך להגדיר את הפרמטר click_action במטען הייעודי (payload) של ההתראה. משתמשים בערך שבו משתמשים עבור המפתח category במטען הייעודי (payload) של APNs. כדי להשתמש בפעולות מותאמות אישית, צריך לרשום אותן קודם. מידע נוסף זמין במדריך לתכנות התראות מקומיות ומרוחקות של Apple.

כדי לקבל תובנות לגבי מסירת הודעות לאפליקציה, אפשר לעיין ב FCMלוח הבקרה של הדוחות, שבו מתועד מספר ההודעות שנשלחו ונפתחו במכשירי Apple ו-Android, וגם נתונים לגבי 'חשיפות' (התראות שהמשתמשים ראו) באפליקציות ל-Android.

טיפול בהתראות שקטות

כששולחים הודעות עם המפתח 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
}

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);
}

פלטפורמות של אפל לא מבטיחות את המסירה של התראות ברקע. כדי לקרוא על תנאים שעלולים לגרום לכשל בהתראות ברקע, אפשר לעיין במסמכים של אפל בנושא שליחת עדכונים ברקע לאפליקציה.

פירוש מטען ייעודי (payload) של הודעת התראה

המטען הייעודי (Payload) של הודעות ההתראה הוא מילון של מפתחות וערכים. הודעות ההתראה שנשלחות דרך APNs הן בפורמט המטען הייעודי (payload) של APNs:

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

טיפול בהודעות כשהשבתתם את החלפת השיטות

כברירת מחדל, אם מקצים את מחלקת נציג האפליקציה של האפליקציה למאפייני הנציג UNUserNotificationCenter ו-Messaging, ‏ FCM יבצע swizzle למחלקת נציג האפליקציה כדי לשייך באופן אוטומטי את אסימון FCM לאסימון APNs של המכשיר ולהעביר אירועים של קבלת התראות אל Analytics. אם משביתים במפורש את החלפת השיטות, אם בונים אפליקציית SwiftUI או אם משתמשים במחלקה נפרדת לכל אחד מהנציגים, צריך לבצע את שתי המשימות האלה באופן ידני.

כדי לשייך את אסימון FCM לאסימון APNs של המכשיר, מעבירים את אסימון APNs למחלקה FCM בtoken refresh handler של delegate האפליקציה באמצעות המאפיין apnsToken.Messaging

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);
}