Check out what’s new from Firebase@ Google I/O 2021, and join our alpha program for early access to the new Remote Config personalization feature. Learn more

Configurer des alertes de nouvelle build dans l'application avec le SDK App Distribution

Le SDK Firebase App Distribution en option vous permet d'afficher des alertes dans l'application à vos testeurs lorsque de nouvelles versions de votre application sont disponibles pour l'installation. Ce guide explique comment utiliser le SDK App Distribution pour créer et personnaliser de nouvelles alertes de build pour vos testeurs.

Avant que tu commences

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet iOS .

Étape 1 : Activer l'API du testeur de distribution d'applications

  1. Sélectionnez votre projet dans Google Cloud Console .

  2. Sous Firebase App Testers API , cliquez sur Activer .

Étape 2 : Ajoutez la distribution d'applications à votre application

Nous vous recommandons d'utiliser CocoaPods pour installer les bibliothèques Firebase. Vous pouvez également choisir d' intégrer directement les frameworks SDK .

  1. Ouvrez le fichier pod que vous avez créé pour le projet (ou exécutez pod init pour en créer un), puis ajoutez la ligne suivante dans la section cible :

    09b9ee070
  2. Dans le répertoire de votre podfile, exécutez pod install , puis ouvrez le fichier .xcworkspace créé.

  3. Encodez votre identifiant d'application Google ( requis uniquement pour les versions iOS 9 et 10 ) :

    Encoder votre identifiant d'application Google

    Ajoutez le schéma d'URL appdistribution-<encoded-google-app-id> en incluant l'extrait de Info.plist file dans votre Info.plist file (reportez-vous à la documentation d' Apple pour savoir comment ajouter le schéma d'URL dans 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>
    

    Ensuite, encodez votre identifiant d'application Google en remplaçant les deux points (:) par des tirets (-). Notez que votre identifiant d'application Google se trouve dans votre fichier GoogleService-Info.plist . Par exemple, si votre ID d'application Google est :

    7:77777777777:ios:123456789

    Votre ID d'appli Google encodé est :

    7-77777777777-ios-123456789
  4. Importez le module Firebase dans votre UIApplicationDelegate :

    Rapide

    import Firebase
    

    Objectif c

    @import Firebase;
    
  5. Configurez une instance partagée FirebaseApp , généralement dans l'application de votre application:didFinishLaunchingWithOptions: méthode :

    Rapide

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

    Objectif c

    // Use Firebase library to configure APIs
    [FIRApp configure];
    
  6. Enfin, recompilez votre application.

Étape 3 : Configurer les alertes dans l'application

Le SDK App Distribution propose deux manières de configurer des alertes de build in-app pour vos testeurs : une configuration d'alerte de base, qui comprend une boîte de dialogue de connexion prédéfinie à afficher pour les testeurs, et une configuration d'alerte avancée, qui vous permet de personnaliser votre propre interface utilisateur (UI). Nous vous recommandons d'utiliser d'abord la configuration d'alerte de base si vous débutez avec le SDK App Distribution.

Configuration de base

Utilisez checkForUpdate pour afficher une checkForUpdate de dialogue d'activation des alertes prédéfinie aux testeurs qui n'ont pas encore activé les alertes, puis vérifiez si une nouvelle version est disponible. Lorsqu'elle est appelée, la méthode édicte la séquence suivante :

  1. Vérifie si un testeur a activé les alertes en l'invitant à se connecter à App Distribution avec son compte Google.

  2. Si le testeur n'a pas encore activé les alertes, affiche une boîte de dialogue prédéfinie.

    L'activation des alertes est un processus unique sur l'appareil de test et persiste à travers les mises à jour de votre application. Les alertes restent activées sur l'appareil de test jusqu'à ce que l'application soit désinstallée ou jusqu'à ce que la méthode signOutTester soit appelée. Voir la documentation de référence de la méthode ( Swift ou Objective-C ) pour plus d'informations.

  3. Vérifie les nouvelles versions disponibles pour le testeur à installer.

Vous pouvez inclure checkForUpdate à tout moment dans votre application. Par exemple, vous pouvez inviter vos testeurs à installer les nouvelles versions disponibles au démarrage en incluant checkForUpdate dans la viewDidAppear de UIViewController .

Les exemples suivants vérifient si le testeur a activé les alertes et a accès à une nouvelle version, et si c'est le cas, affiche une boîte de dialogue lorsque la version est disponible pour l'installation :

Vérifiez les alertes activées :

Rapide

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

Objectif 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).
}];

Afficher la boîte de dialogue d'installation du nouveau build :

Rapide

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

Objectif 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];
  }
}];

Configuration avancée

Les méthodes signInTester et isTesterSignedIn vous offrent plus de flexibilité pour personnaliser l'expérience de connexion de votre testeur, afin qu'elle corresponde mieux à l'apparence de votre application.

L'exemple suivant vérifie si le testeur s'est déjà connecté à son compte de testeur Firebase App Distribution. Vous pouvez donc choisir d'afficher votre interface utilisateur de connexion uniquement pour les testeurs qui ne se sont pas encore connectés. Une fois que le testeur s'est connecté, vous pouvez alors appelez checkForUpdate pour vérifier si le testeur a accès à une nouvelle version.

Rapide

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

Objectif 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
  }];
}

Pour plus d'informations sur les méthodes supplémentaires, y compris signOutTester , consultez la documentation de référence App Distribution pour Swift et Objective-C .

Étape 4 : Construisez et testez votre implémentation

Enfin, créez votre application et testez votre implémentation en distribuant la version aux testeurs à l'aide de la console Firebase.

Consultez le guide de dépannage de la distribution d'applications pour obtenir de l'aide sur les problèmes courants, tels que :

  • Le testeur ne reçoit pas d'alertes dans l'application
  • Le testeur est invité à se connecter plusieurs fois à Google