Prise en main de tvOS

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser n’importe quel ou tous les services.

Commençons par configurer le Kit de développement logiciel (SDK) App Center tvOS dans votre application pour utiliser App Center Analytics et App Center Crashes.

1. Prérequis

Les conditions suivantes doivent être remplies pour utiliser le Kit de développement logiciel (SDK) App Center :

• Votre tvOS est configuré dans Xcode 13 ou version ultérieure sur tvOS version 11 ou ultérieure.
• Vous n’utilisez aucune autre bibliothèque qui fournit des fonctionnalités de rapports d’incident.

2. Créez votre application dans le portail App Center pour obtenir le secret d’application

Si vous avez déjà créé votre application dans le portail App Center, vous pouvez ignorer cette étape.

1. Passez à appcenter.ms.
2. Inscrivez-vous ou connectez-vous et appuyez sur le bouton bleu situé en haut à droite du portail, qui indique Ajouter nouveau et sélectionnez Ajouter une nouvelle application dans le menu déroulant.
3. Entrez un nom et une description facultative pour votre application.
4. Sélectionnez tvOS comme système d’exploitation et Objective-C/Swift comme plateforme.
5. Appuyez sur le bouton en bas à droite, indiquant Ajouter une nouvelle application.

Une fois que vous avez créé une application, vous pouvez obtenir son secret d’application sur la page Paramètres du portail App Center. En haut à droite de la page Paramètres , cliquez sur les points verticaux triples et sélectionnez Copy app secret pour obtenir votre secret d’application.

3. Ajouter les modules du Kit de développement logiciel (SDK) App Center

Le Kit de développement logiciel (SDK) App Center pour tvOS peut être intégré à votre application via Cocoapods, Carthage, Swift Package Manager ou en ajoutant manuellement les fichiers binaires à votre projet.

3.1 Intégration via Cocoapods

1. Ajoutez les dépendances suivantes à votre podfile pour inclure App Center Analytics et App Center Défaillances dans votre app. Cela extrait les frameworks suivants : AppCenter, AppCenterAnalytics et AppCenterCrashes. Au lieu de cela, vous pouvez spécifier les services que vous souhaitez utiliser dans votre application. Chaque service a sa propre sous-spécification et ils s’appuient tous sur AppCenter. Elle sera automatiquement extraite.

    # Use the following line to use App Center Analytics and Crashes.
    pod 'AppCenter'
   
    # Use the following lines if you want to specify which service you want to use.
    pod 'AppCenter/Analytics'
    pod 'AppCenter/Crashes'
   

2. Exécutez pod install pour installer votre pod nouvellement défini et ouvrez le projet .xcworkspace.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le Kit de développement logiciel (SDK) et d’utiliser les services App Center.

3.2 Intégration via Carthage

Vous trouverez ci-dessous les étapes à suivre pour intégrer le Kit de développement logiciel (SDK) App Center dans votre projet Xcode à l’aide de Carthage version 0.30 ou ultérieure, un gestionnaire de dépendances décentralisé qui génère vos dépendances et vous fournit des frameworks binaires.

1. Ajoutez les dépendances suivantes à votre Cartfile pour inclure App Center Analytics et App Center Défaillances dans votre app.

   # Use the following line to get the latest version of App Center
   github "microsoft/appcenter-sdk-apple"
   

   # Use the following line to get the specific version of App Center
   github "microsoft/appcenter-sdk-apple" ~> X.X.X
   

2. Exécutez carthage update --platform tvOS. Cela extrait les dépendances dans un dossier Carthage/Checkouts , puis génère chaque infrastructure.

3. Ouvrez l’onglet Paramètres généraux de votre cible d’application. Faites glisser et déposez AppCenter.framework, AppCenterAnalytics.framework et les fichiers AppCenterCrashes.framework à partir du dossier Carthage/Build/tvOS dans le navigateur de projet de Xcode. AppCenter.framework est requis pour démarrer le Kit de développement logiciel (SDK). S’il n’est pas ajouté au projet, les autres modules ne fonctionnent pas et votre application ne se compile pas.

4. Une boîte de dialogue s’affiche, vérifiez que la cible de votre application est cochée. Puis, cliquez sur Terminer.

   Remarque

   Si vous utilisez carthage copy-frameworks dans votre phase de génération , vous ne devez pas ajouter les kits SDK App Center là-bas, car ils sont expédiés en tant que frameworks statiques.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le Kit de développement logiciel (SDK) et d’utiliser les services App Center.

3.3 Intégration via Swift Package Manager

1. Dans le menu Xcode, cliquez sur Fichier > Paquets Swift > Ajouter une Dépendance de Paquet.
2. Dans la boîte de dialogue qui s’affiche, entrez l’URL du référentiel : https://github.com/microsoft/appcenter-sdk-apple.git.
3. Dans Version, sélectionnez Jusqu’à La majeure suivante et utilisez l’option par défaut.
4. Choisissez les modules dont vous avez besoin dans la colonne Package Product .

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le Kit de développement logiciel (SDK) et d’utiliser les services App Center.

3.4 Intégration en copiant les fichiers binaires dans votre projet

Vous trouverez ci-dessous les étapes à suivre pour intégrer les fichiers binaires compilés dans votre projet Xcode pour configurer App Center Analytics et App Center Crashs pour votre application tvOS.

1. Téléchargez les infrastructures du Kit de développement logiciel (SDK) App Center fournies sous forme de fichier zip.

2. Décompressez le fichier et vous verrez un dossier appelé AppCenter-SDK-Apple qui contient des frameworks différents pour chaque service App Center sur chaque dossier de plateforme. L’infrastructure appelée AppCenter est requise dans le projet, car elle contient du code partagé entre les différents modules.

3. [Facultatif] Créez un sous-répertoire pour les bibliothèques tierces.

   • En guise de meilleure pratique, les bibliothèques tierces se trouvent généralement dans un sous-répertoire (il est souvent appelé Vendor), donc si vous n’avez pas votre projet organisé avec un sous-répertoire pour les bibliothèques, créez un sous-répertoire Vendor maintenant.
   • Créez un groupe appelé Vendor à l’intérieur de votre projet Xcode pour imiter votre structure de fichiers sur le disque.

4. Ouvrez le dossier AppCenter-SDK-Apple décompressé dans Finder et copiez le dossier dans le dossier de votre projet à l’emplacement où vous le souhaitez. Le dossier contient des frameworks dans des sous-dossiers pour d’autres plateformes prises en charge par le Kit de développement logiciel (SDK) App Center. Vous devrez peut-être supprimer des sous-dossiers dont vous n’avez pas besoin.

5. Ajoutez les frameworks sdk au projet dans Xcode :

   • Vérifiez que le navigateur de projets est visible (⌘+1).
   • Faites maintenant glisser et déposez AppCenter.framework, AppCenterAnalytics.framework et AppCenterCrashes.framework à partir du Finder (ceux du dossier Vendor ) dans le navigateur de projet de Xcode. AppCenter.framework est requis pour démarrer le Kit de développement logiciel (SDK), vérifiez qu’il est ajouté à votre projet ; sinon, les autres modules ne fonctionnent pas et votre application ne sera pas compilée.
   • Une boîte de dialogue s’affiche, vérifiez que la cible de votre application est cochée. Puis, cliquez sur Terminer.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le Kit de développement logiciel (SDK) et d’utiliser les services App Center.

4. Démarrez le Kit de développement logiciel (SDK)

Pour utiliser App Center, vous devez choisir le ou les modules que vous souhaitez utiliser. Par défaut, aucun module n’est démarré et vous devez appeler explicitement chacun d’eux lors du démarrage du Kit de développement logiciel (SDK).

4.1 Ajouter les instructions d’importation

Ouvrez le fichier AppDelegate du projet et ajoutez les instructions d’importation suivantes :

@import AppCenter;
@import AppCenterAnalytics;
@import AppCenterCrashes;

import AppCenter
import AppCenterAnalytics
import AppCenterCrashes

4.2 Ajouter la start:withServices: méthode

Insérez la ligne suivante dans la méthode déléguée de l’application didFinishLaunchingWithOptions :

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self])

Si vous devez démarrer les services App Center séparément, vous devez :

1. Configurez ou démarrez-le avec le secret de l’application.
2. Si le code peut être appelé plusieurs fois, vérifiez si l’App Center est déjà configuré.
3. Démarrez le ou les services requis sans secret d’application.

[MSACAppCenter configureWithAppSecret:@"{Your App Secret}"];
if ([MSACAppCenter isConfigured]) {
   [MSACAppCenter startService:[MSACAnalytics class]];
   [MSACAppCenter startService:[MSACCrashes class]];
}

AppCenter.configure(withAppSecret: "{Your App Secret}")
if AppCenter.isConfigured {
    AppCenter.startService(Analytics.self)
    AppCenter.startService(Crashes.self)
}

4.3 Remplacer l’espace réservé par votre secret d’application

Veillez à remplacer {Your App Secret} le texte par la valeur réelle de votre application. La clé secrète de l’application se trouve dans la page Prise en main ou la page Paramètres du portail App Center.

La page Prise en main contient l’exemple de code ci-dessus avec votre secret d’application dans celui-ci, vous pouvez copier-coller l’exemple entier.

L’exemple ci-dessus montre comment utiliser la méthode start:withServices (start(withAppSecret:services:) pour Swift) et inclure à la fois App Center Analytics et App Center Crashes.

Si vous ne souhaitez pas utiliser l’un des deux services, supprimez le paramètre correspondant de l’appel de méthode ci-dessus.

Sauf si vous spécifiez chaque module comme paramètre dans la méthode de démarrage, vous ne pouvez pas utiliser ce service App Center. En outre, l’API start:withServices (start(withAppSecret:services:) pour Swift) ne peut être utilisée qu’une seule fois dans le cycle de vie de votre application . tous les autres appels consignent un avertissement à la console et seuls les modules inclus dans le premier appel seront disponibles.

Par exemple : si vous souhaitez intégrer App Center Analytics, vous devez modifier l’appel start:withServices d’API (start(withAppSecret:services:) pour Swift) comme suit :

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self])

Excellent, vous êtes tous configurés pour visualiser les données d’analyse et de blocage sur le portail que le SDK collecte automatiquement.

Consultez la documentation relative aux incidents App Center Analytics et App Center Pour savoir comment personnaliser et utiliser des fonctionnalités plus avancées des deux services.