Menyiapkan aplikasi klien Firebase Cloud Messaging di platform Apple

Untuk aplikasi klien Apple, Anda dapat menerima payload notifikasi dan payload data hingga 4.000 byte melalui antarmuka APN Firebase Cloud Messaging.

Untuk menulis kode klien di Objective-C atau Swift, sebaiknya gunakan FIRMessaging API. Contoh panduan memulai ini menyediakan kode contoh untuk kedua bahasa tersebut.

Method swizzling di Firebase Cloud Messaging

FCM SDK menjalankan method swizzling pada dua area utama: memetakan token APN ke token pendaftaran FCM, dan mencatat data analisis selama penanganan callback pesan downstream. Developer yang memilih untuk tidak menggunakan swizzling dapat menonaktifkannya dengan menambahkan flag FirebaseAppDelegateProxyEnabled di file Info.plist aplikasi dan menyetelnya ke NO (nilai boolean). Area terkait dalam panduan ini menyediakan contoh kode dengan method swizzling yang diaktifkan maupun tidak diaktifkan.

Penting: Saat menggunakan Firebase Unity SDK di iOS, jangan nonaktifkan method swizzling. Swizzling diperlukan oleh SDK dan jika dinonaktifkan, fitur-fitur penting Firebase, misalnya penanganan token FCM, tidak akan berfungsi dengan benar.

Menambahkan Firebase ke project Apple

Jika belum, tambahkan Firebase ke project Apple Anda.

Mengupload kunci autentikasi APN

Upload kunci autentikasi APN Anda ke Firebase. Jika Anda belum memiliki kunci autentikasi APN, pastikan untuk membuatnya di Apple Developer Member Center.

1. Pada project Anda di Firebase console, pilih ikon roda gigi, pilih Project Settings, lalu pilih tab Cloud Messaging.

2. Di bagian APNs authentication key pada iOS app configuration, klik tombol Upload.

3. Cari lokasi penyimpanan kunci, pilih lokasi tersebut, lalu klik Open. Tambahkan ID kunci tersebut (tersedia di Apple Developer Member Center) dan klik Upload.

Mendaftar untuk notifikasi jarak jauh

Saat aplikasi dimulai, atau pada waktu lain yang diinginkan dalam alur aplikasi, daftarkan aplikasi Anda untuk mengaktifkan notifikasi jarak jauh. Panggil registerForRemoteNotifications seperti yang ditunjukkan berikut:

Catatan: Aplikasi SwiftUI harus menggunakan wrapper properti UIApplicationDelegateAdaptor atau NSApplicationDelegateAdaptor untuk memberikan jenis yang sesuai dengan protokol delegasi aplikasi yang tepat.

Swift

UNUserNotificationCenter.current().delegate = self

let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
UNUserNotificationCenter.current().requestAuthorization(
  options: authOptions,
  completionHandler: { _, _ in }
)

application.registerForRemoteNotifications()
AppDelegate.swift

Objective-C

[UNUserNotificationCenter currentNotificationCenter].delegate = self;
UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
    UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
[[UNUserNotificationCenter currentNotificationCenter]
    requestAuthorizationWithOptions:authOptions
    completionHandler:^(BOOL granted, NSError * _Nullable error) {
      // ...
    }];

[application registerForRemoteNotifications];
AppDelegate.m

Anda harus menetapkan properti delegate UNUserNotificationCenter dan properti delegate FIRMessaging. Misalnya, di aplikasi iOS, tetapkan dalam metode applicationWillFinishLaunchingWithOptions: atau applicationDidFinishLaunchingWithOptions: di delegasi aplikasi.

Mengakses token pendaftaran

Secara default, FCM SDK membuat token pendaftaran untuk instance aplikasi klien saat peluncuran aplikasi. Serupa dengan token perangkat APN, token ini dapat Anda gunakan untuk mengirimkan notifikasi bertarget ke instance tertentu dari aplikasi Anda.

Dengan cara yang sama seperti ketika platform Apple mengirimkan token perangkat APN pada saat aplikasi dimulai, FCM akan menyediakan token pendaftaran melalui metode messaging:didReceiveRegistrationToken: dari FIRMessagingDelegate. FCM SDK mengambil token baru atau yang ada saat peluncuran awal aplikasi dan setiap kali token diperbarui atau dibatalkan validasinya. Dalam semua kasus, FCM SDK memanggil messaging:didReceiveRegistrationToken: dengan token yang valid.

Aplikasi yang masih menggunakan Instance ID API yang tidak digunakan lagi untuk pengelolaan token harus memperbarui semua logika token agar menggunakan FCM API yang dijelaskan di sini.

Token pendaftaran dapat berubah jika:

• Aplikasi dipulihkan di perangkat baru
• Pengguna melakukan uninstal/instal ulang aplikasi
• Pengguna menghapus data aplikasi.

Menetapkan delegasi pesan

Untuk menerima token pendaftaran, terapkan protokol delegasi pesan dan tetapkan properti delegate dari FIRMessaging setelah memanggil [FIRApp configure]. Misalnya, jika delegasi aplikasi Anda sesuai dengan protokol delegasi pesan, Anda dapat menetapkan delegasi di application:didFinishLaunchingWithOptions: ke properti itu sendiri.

Swift

Messaging.messaging().delegate = self

Objective-C

[FIRMessaging messaging].delegate = self;

Mengambil token pendaftaran saat ini

Token pendaftaran dikirimkan melalui metode messaging:didReceiveRegistrationToken:. Biasanya metode ini dipanggil sekali pada saat aplikasi dimulai dengan token pendaftaran. Saat metode ini dipanggil, inilah saat yang tepat untuk:

• Mengirim token pendaftaran ke server aplikasi jika token itu masih baru.
• Mengatur token pendaftaran agar berlangganan topik. Ini hanya diperlukan untuk langganan baru atau untuk situasi saat pengguna menginstal ulang aplikasi.

Anda dapat mengambil token secara langsung menggunakan token(completion:). Error yang bukan null diberikan jika pengambilan token gagal dengan cara apa pun.

Swift

Messaging.messaging().token { token, error in
  if let error = error {
    print("Error fetching FCM registration token: \(error)")
  } else if let token = token {
    print("FCM registration token: \(token)")
    self.fcmRegTokenMessage.text  = "Remote FCM registration token: \(token)"
  }
}

Objective-C

[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) {
  if (error != nil) {
    NSLog(@"Error getting FCM registration token: %@", error);
  } else {
    NSLog(@"FCM registration token: %@", token);
    self.fcmRegTokenMessage.text = token;
  }
}];

Anda dapat menggunakan metode ini kapan saja untuk mengakses token, sehingga Anda tidak perlu menyimpannya.

Memantau refresh pada token

Agar mendapatkan notifikasi setiap kali token diperbarui, berikan delegasi yang sesuai dengan protokol delegasi pesan. Berikut ini contoh pendaftaran delegasi dan penambahan metode delegasi yang tepat:

Swift

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
  print("Firebase registration token: \(String(describing: fcmToken))")

  let dataDict: [String: String] = ["token": fcmToken ?? ""]
  NotificationCenter.default.post(
    name: Notification.Name("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.
}
AppDelegate.swift

Objective-C

- (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.
}
AppDelegate.m

Atau, Anda dapat memproses NSNotification yang bernama kFIRMessagingRegistrationTokenRefreshNotification, daripada memberikan metode delegasi. Properti token selalu memiliki nilai token saat ini.

Swizzling dinonaktifkan: memetakan token APN dan token pendaftaran

Jika Anda telah menonaktifkan method swizzling atau membuat aplikasi SwiftUI, Anda harus memetakan token APN ke token pendaftaran FCM secara eksplisit. Terapkan metode application(_:didRegisterForRemoteNotificationsWithDeviceToken:) untuk mengambil token APN, lalu tetapkan properti apnsToken dari Messaging:

Swift

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

Objective-C

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

Setelah token pendaftaran FCM dibuat, Anda dapat mengaksesnya dan memproses peristiwa refresh menggunakan metode yang sama dengan yang mengaktifkan swizzling.

Mencegah inisialisasi otomatis

Saat token pendaftaran FCM dibuat, library mengupload data konfigurasi dan ID ke Firebase. Jika ingin mendapatkan keikutsertaan eksplisit dari pengguna terlebih dahulu, Anda dapat mencegah pembuatan token pada saat konfigurasi dengan menonaktifkan FCM. Untuk melakukan ini, tambahkan nilai metadata ke Info.plist (bukan GoogleService-Info.plist):

FirebaseMessagingAutoInitEnabled = NO

Untuk mengaktifkan kembali FCM, Anda dapat membuat panggilan runtime:

Swift

Messaging.messaging().autoInitEnabled = true

Objective-C

[FIRMessaging messaging].autoInitEnabled = YES;

Nilai ini akan tetap sama setiap kali aplikasi dimulai ulang.

Langkah berikutnya

Setelah menyiapkan klien Apple, Anda siap untuk menambahkan penanganan pesan dan perilaku lainnya yang lebih canggih ke aplikasi Anda. Lihat panduan ini untuk mengetahui informasi lebih lanjut:

• Menerima pesan di aplikasi Apple
• Mengirim pesan topik
• Mengirim ke grup perangkat