Informer les testeurs des nouvelles compilations

iOS+ Android

Les SDK iOS et Android Firebase App Distribution sont des versions bêta. Cela signifie que la fonctionnalité peut faire l'objet de modifications susceptibles d'affecter la rétrocompatibilité. Une version bêta n'est soumise à aucun contrat de niveau de service ni à aucun règlement d'obsolescence. Elle peut bénéficier d'une assistance limitée ou aucune.

Les SDK Firebase App Distribution et Android facultatifs vous permettent 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 les SDK iOS et Android App Distribution pour créer et personnaliser de nouvelles alertes de compilation pour vos testeurs.

Avant de commencer

Si ce n'est pas encore fait, ajoutez Firebase à votre projet iOS.

Remarque :Si votre projet Firebase comporte plusieurs applications, assurez-vous que l'application que vous souhaitez distribuer avec App Distribution possède son propre fichier de configuration GoogleServices-info.plist. Pour en savoir plus, consultez la section Compatibilité avec plusieurs environnements.

Étape 1: Activez l'API Testeur App Distribution

1. Sélectionnez votre projet dans la console Google Cloud.

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

Étape 2 : Ajouter App Distribution à votre application

Remarque:Firebase est compatible avec CocoaPods et Swift Package Manager. Si vous choisissez d'installer Firebase à l'aide de Swift Package Manager, vous pouvez ignorer les étapes liées à CocoaPods, comme modifier les fichiers Pod et exécuter la commande pod.

1. Ouvrez le fichier Podfile 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 :

   pod 'FirebaseAppDistribution'

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

3. Importez le module Firebase dans votre struct App ou UIApplicationDelegate :

   Swift

   import FirebaseCore
   import FirebaseAppDistribution
   

   Objective-C

   @import FirebaseCore;
   @import FirebaseAppDistribution;
   

4. Configurez une instance partagée FirebaseApp dans la méthode application(_:didFinishLaunchingWithOptions:) de votre délégué d'application :

   Swift

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

   Objective-C

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

5. Si le forçage de l'ordre des caractères est désactivé, transmettez toutes les URL ouvertes au SDK App Distribution dans votre implémentation de application(_:open:options:) :

   Swift

   func application(_ app: UIApplication, 
                    open url: URL,
                    options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
      if AppDistribution.appDistribution().application(application, open: url, options: options) {
         return true
      }
   
      // Handle other non-Firebase URLs here.
   
      return false
   }
   

   Objective-C

   - (BOOL)application:(UIApplication *)app 
               openURL:(NSURL *)url 
               options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
      if ([[FIRAppDistribution appDistribution] application:app openURL:url options:options]) {
         return YES;
      }
   
      // Handle other non-Firebase URLs here.
   
      return NO;
   }
   

6. Enfin, recompilez votre application.

Étape 3 : Configurer les alertes dans l'application

Le SDK App Distribution propose deux méthodes pour configurer des alertes de compilation dans l'application pour vos testeurs: une configuration d'alerte de base, qui inclut une mise à jour de l'application et des boîtes de dialogue de connexion prédéfinies à afficher pour les testeurs, et une configuration d'alerte avancée qui vous permet de personnaliser votre propre interface utilisateur. Nous vous recommandons d'utiliser d'abord la configuration d'alerte de base si vous ne connaissez pas le SDK App Distribution.

Configuration de base

Utilisez checkForUpdate pour afficher une boîte de dialogue d'activation des alertes prédéfinie aux testeurs qui ne les ont pas encore activées, puis vérifiez si une nouvelle version est disponible. Lorsqu'elle est appelée, la méthode exécute 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 ponctuel sur l'appareil de test et persiste entre 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. Pour en savoir plus, consultez la documentation de référence de la méthode (Swift ou Objective-C).

3. Recherche les nouveaux builds disponibles que le testeur peut installer.

Vous pouvez appeler checkForUpdate() à tout moment dans votre application. Par exemple, vous pouvez inviter vos testeurs à installer les builds nouvellement disponibles au démarrage en incluant checkForUpdate() dans le onAppear(perform:) de la vue racine de votre application.

L'exemple suivant vérifie si le testeur a activé les alertes et s'il a accès à une nouvelle version. Si c'est le cas, un message s'affiche lorsque la version est disponible à l'installation :

Swift

Remarque:Ce produit n'est pas disponible sur les cibles macOS, Mac Catalyst, tvOS et watchOS.

AppDistribution.appDistribution().checkForUpdate(completion: { release, error in
  if error != nil {
      // Handle error
      return
  }

  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

Remarque:Ce produit n'est pas disponible sur les cibles macOS, Mac Catalyst, tvOS et watchOS.

[[FIRAppDistribution appDistribution]
  checkForUpdateWithCompletion:^(FIRAppDistributionRelease *_Nullable release,
                                 NSError *_Nullable error) {
  if (error) {
    // Handle error
    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 permettent de personnaliser plus facilement 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 ainsi choisir d'afficher votre UI de connexion uniquement pour les testeurs qui ne se sont pas encore connectés. Une fois que le testeur s'est connecté, vous pouvez appeler checkForUpdate() pour vérifier s'il a accès à une nouvelle version.

Swift

Remarque:Ce produit n'est pas disponible sur les cibles macOS, Mac Catalyst, tvOS et watchOS.

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

Remarque:Ce produit n'est pas disponible sur les cibles macOS, Mac Catalyst, tvOS et watchOS.

// 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 en savoir plus 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: Créez et testez votre mise en œuvre

Enfin, compilez votre application et testez votre implémentation en distribuant le build aux testeurs à l'aide de la console Firebase.

Remarque : Vous ne pouvez pas tester les alertes dans l'application sur un simulateur. Pour tester votre implémentation, utilisez un véritable appareil de test et assurez-vous qu'il est autorisé à installer des builds à partir de App Distribution (pour savoir comment configurer votre appareil de test, consultez la section Configurer pour les tests).

Consultez le guide de dépannage App Distribution pour obtenir de l'aide concernant les problèmes courants, comme:

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