Menyiapkan pemberitahuan build baru dalam aplikasi dengan App Distribution SDK

Firebase App Distribution SDK merupakan rilis beta. Ini berarti bahwa fungsionalitasnya dapat berubah dengan cara yang membuatnya tidak kompatibel dengan versi sebelumnya. Rilis beta tidak tunduk pada SLA atau kebijakan penghentian layanan dan dukungannya mungkin terbatas atau tidak ada sama sekali.

Firebase App Distribution SDK, yang bersifat opsional untuk digunakan, memungkinkan Anda menampilkan pemberitahuan dalam aplikasi kepada penguji saat build baru aplikasi tersedia untuk diinstal. Panduan ini menjelaskan cara menggunakan App Distribution SDK untuk membuat dan menyesuaikan pemberitahuan build baru untuk penguji Anda.

Sebelum memulai

Tambahkan Firebase ke project iOS jika Anda belum melakukannya.

Catatan: Jika Anda memiliki beberapa aplikasi di project Firebase, pastikan aplikasi yang ingin didistribusikan dengan App Distribution memiliki file konfigurasi GoogleServices-info.plist sendiri. Untuk mengetahui informasi selengkapnya, lihat Mendukung beberapa lingkungan.

Langkah 1: Aktifkan App Distribution Tester API

1. Pilih project Anda di Google Cloud Console.

2. Di bagian Firebase App Testers API, klik Aktifkan.

   Catatan: Untuk sebagian pelanggan G Suite, jika "Partner Dash" dinonaktifkan, Anda akan mengalami pengalihan balik saat melalui alur login penguji. Layanan ini diaktifkan secara default, tetapi jika dinonaktifkan, hubungi admin G Suite untuk mengaktifkan layanan Partner Dash di bagian Layanan Tambahan di organisasi G Suite Anda.

Langkah 2: Tambahkan App Distribution ke aplikasi Anda

Sebaiknya gunakan CocoaPods untuk menginstal library Firebase. Namun, jika tidak ingin menggunakan CocoaPods, Anda bisa mengintegrasikan framework SDK secara langsung.

1. Buka podfile yang Anda buat untuk project (atau jalankan pod init untuk membuatnya), lalu tambahkan baris berikut di dalam bagian target:

   pod 'Firebase/AppDistribution'

2. Di direktori podfile, jalankan pod install, lalu buka file .xcworkspace yang dibuat.

3. Enkode ID aplikasi Google Anda (hanya diperlukan untuk iOS versi 9 dan 10):

   Mengenkode ID aplikasi Google

   Tambahkan skema URL appdistribution-<encoded-google-app-id> dengan menyertakan cuplikan di Info.plist file (lihat dokumentasi Apple untuk melihat petunjuk tentang cara menambahkan skema URL di Xcode):

   <key>CFBundleURLTypes</key>
   <array>
       <dict>
           <key>CFBundleTypeRole</key>
           <string>Editor</string>
           <key>CFBundleURLSchemes</key>
           <array>
               <string>appdistribution-<encoded-google-app-id></string>
           </array>
       </dict>
   </array>
   

   Kemudian, enkode ID aplikasi Google Anda dengan mengganti titik dua (:) dengan tanda pisah (-). Perhatikan bahwa ID aplikasi Google terletak di file GoogleService-Info.plist Anda. Misalnya, jika ID aplikasi Google Anda adalah:

   7:77777777777:ios:123456789

   ID aplikasi Google yang dienkode adalah:

   7-77777777777-ios-123456789

4. Impor modul Firebase di UIApplicationDelegate Anda:

   Swift

   import Firebase
   

   Objective-C

   @import Firebase;
   

5. Konfigurasikan instance bersama FirebaseApp, yang biasanya ada dalam metode application:didFinishLaunchingWithOptions: aplikasi Anda:

   Swift

   // Use Firebase library to configure APIs
   FirebaseApp.configure()
   

   Objective-C

   // Use Firebase library to configure APIs
   [FIRApp configure];
   

6. Terakhir, kompilasi ulang aplikasi Anda.

Langkah 3: Konfigurasikan pemberitahuan dalam aplikasi

App Distribution SDK menyediakan dua cara untuk menyiapkan pemberitahuan build dalam aplikasi bagi penguji: konfigurasi pemberitahuan dasar, yang dilengkapi dengan dialog login bawaan untuk ditampilkan kepada penguji, dan konfigurasi pemberitahuan lanjutan, yang memungkinkan Anda menyesuaikan antarmuka pengguna (UI) Anda sendiri. Jika Anda baru menggunakan SDK, sebaiknya coba konfigurasi pemberitahuan dasar terlebih dahulu.

Catatan: Pemberitahuan dalam aplikasi tidak dapat diuji pada simulator. Untuk menguji penerapan Anda, gunakan perangkat uji sungguhan dan pastikan perangkat diaktifkan untuk menginstal build dari App Distribution (untuk melihat petunjuk tentang cara menyiapkan perangkat uji, lihat Menyiapkan pengujian).

Konfigurasi dasar

Gunakan checkForUpdate untuk menampilkan dialog pemberitahuan pengaktifan bawaan kepada penguji yang belum mengaktifkan pemberitahuan, lalu periksa apakah build baru tersedia. Saat dipanggil, metode tersebut akan menerapkan urutan berikut:

1. Memeriksa apakah penguji telah mengaktifkan pemberitahuan dengan memintanya login ke App Distribution dengan Akun Google-nya.

2. Jika penguji belum mengaktifkan pemberitahuan, dialog yang telah dibuat sebelumnya akan ditampilkan. Mengaktifkan pemberitahuan adalah proses satu kali di perangkat uji dan tetap ada saat update aplikasi dilakukan. Setelah diaktifkan, pemberitahuan tetap aktif di perangkat hingga aplikasi di-uninstal, atau sampai metode signOutTester dipanggil (untuk informasi selengkapnya tentang metode konfigurasi lanjutan ini, lihat dokumentasi referensi App Distribution untuk Swift dan Objective-C).

3. Memeriksa build yang baru tersedia agar dapat diinstal oleh penguji.

Misalnya, kode berikut memeriksa apakah penguji telah mengaktifkan pemberitahuan dan memiliki akses ke build baru:

Swift

AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
// Includes a pre-built enable alerts dialogue that lets your tester enable alerts.
// You can also customize your own user interface that prompts the tester to
// install a newly available distribution (refer to sample code below).
})

Objective-C

[[FIRAppDistribution appDistribution]
    checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                   NSError *_Nullable error) {
// Includes a pre-built enable alerts dialogue that lets your tester enable alerts.
// You can also customize your own user interface that prompts the tester to
// install a newly available distribution (refer to sample code below).
}];

Perhatikan bahwa Anda dapat menyertakan metode ini kapan saja di aplikasi Anda. Misalnya, Anda dapat meminta penguji untuk menginstal build yang baru tersedia saat startup dengan menyertakan checkForUpdate di viewDidAppear dari UIViewController.

Contoh berikut menampilkan dialog kepada penguji saat build baru tersedia untuk diinstal:

Swift

AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
  guard let release = release else {
    return
  }

  // Customize your alerts here.
  let title = "New Version Available"
  let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
  let uialert = UIAlertController(title: title,message: message, preferredStyle: .alert)

  uialert.addAction(UIAlertAction(title: "Update", style: UIAlertAction.Style.default) {
    _ in
    UIApplication.shared.open(release.downloadURL)
  })
  uialert.addAction(UIAlertAction(title: "Cancel", style: UIAlertAction.Style.cancel) {
    _ in
  })

  // self should be a UIViewController.
  self.present(uialert, animated: true, completion: nil)
})

Objective-C

[[FIRAppDistribution appDistribution]
  checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                 NSError *_Nullable error) {
  if (error) {
  UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"Check For Update"
message:[NSString stringWithFormat:@"Error during tester sign in! %@", error.localizedDescription]
preferredStyle:UIAlertControllerStyleAlert];

  UIAlertAction *okAction = [UIAlertAction actionWithTitle:@"Ok" style:UIAlertActionStyleDefault
handler:^(UIAlertAction *action) {}];

  [alert addAction:okAction];
  [self presentViewController:alert animated:YES completion:nil];

  return;
  }

  if (release) {
  UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"New Version Available"
message:[NSString stringWithFormat:@"Version %@ (%@) is available.", release.displayVersion,
release.buildVersion] preferredStyle:UIAlertControllerStyleAlert];

  UIAlertAction *updateAction = [UIAlertAction actionWithTitle:@"Update"
style:UIAlertActionStyleDefault handler:^(UIAlertAction *action) {
    [[UIApplication sharedApplication] openURL:release.downloadURL options:@{}
completionHandler:nil];
  }];
  UIAlertAction *cancelAction = [UIAlertAction actionWithTitle:@"Cancel"
style:UIAlertActionStyleCancel handler:^(UIAlertAction *action) {}];
  [alert addAction:updateAction];
  [alert addAction:cancelAction];
  [self presentViewController:alert animated:YES completion:nil];
  }
}];

Untuk mengetahui informasi tentang metode tambahan, lihat dokumentasi referensi App Distribution untuk Swift dan Objective-C.

Konfigurasi lanjutan

Metode signInTester dan isTesterSignedIn memberi Anda fleksibilitas lebih besar dalam menyesuaikan pengalaman login penguji, sehingga lebih cocok dengan tampilan dan nuansa aplikasi Anda.

Contoh berikut memeriksa apakah penguji telah login ke akun penguji Firebase App Distribution, sehingga Anda dapat memilih untuk menampilkan UI login hanya untuk penguji yang belum login. Setelah penguji login, Anda dapat memanggil checkForUpdate untuk memeriksa apakah penguji memiliki akses ke build baru.

Swift

// Sign in a tester without automatically checking for update
if (!AppDistribution.appDistribution().isTesterSignedIn) {
  AppDistribution.appDistribution().signInTester (completion: { error in
    // completion block for signInTester
     if (error != nil) {
       // handle failed sign in
      return
     }
    // handle successful sign in
  })
}

// Only check for update if tester is already signed in - do not prompt
if (AppDistribution.appDistribution().isTesterSignedIn) {
  AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
      // completion block for check for update
  })
}

Objective-C

// Sign in a tester without automatically checking for update
if(![[FIRAppDistribution appDistribution] isTesterSignedIn]) {
  [[FIRAppDistribution appDistribution]
    signInTesterWithCompletion:^(NSError *_Nullable error) {
      // completion block for signInTester
     if (error) {
       // handle failed sign in
       return;
     }
      // handle successful sign in
  }];
}

// only check for update if tester is already signed in - do not prompt
if([[FIRAppDistribution appDistribution] isTesterSignedIn]) {
  [[FIRAppDistribution appDistribution]
        checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                       NSError *_Nullable error) {
     // completion block for check for update
  }];
}

Untuk mengetahui informasi tentang metode tambahan, termasuk signOutTester, lihat dokumentasi referensi App Distribution untuk Swift dan Objective-C.

Langkah 4: Build dan uji implementasi Anda

Terakhir, build aplikasi dan uji implementasi Anda dengan mendistribusikan build kepada penguji menggunakan Firebase console.

Buka panduan Pemecahan Masalah App Distribution untuk mendapatkan bantuan terkait masalah umum, seperti:

• Penguji yang tidak menerima pemberitahuan dalam aplikasi
• Penguji yang diminta untuk login ke Google lebih dari sekali