Prise en main de tvOS

Important

La mise hors service de Visual Studio App Center est prévue pour le 31 mars 2025. Bien que vous puissiez continuer à utiliser Visual Studio App Center jusqu’à sa mise hors service complète, il existe plusieurs alternatives recommandées vers lesquelles vous pouvez envisager la migration.

En savoir plus sur les chronologies et les alternatives de support.

• Android
• iOS
• Extensions iOS
• React Native
• MAUI/Xamarin
• UWP
• WPF/WinForms
• Unity
• macOS
• Extensions macOS
• tvOS
• Cordova

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser tout ou partie des services.

Commençons à configurer app Center tvOS SDK dans votre application pour utiliser App Center Analytics et les incidents App Center.

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 rapport d’incident.

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

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

1. Rendez-vous à appcenter.ms.
2. Inscrivez-vous ou connectez-vous et appuyez sur le bouton bleu dans le coin supérieur droit 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 qui indique Ajouter une nouvelle application.

Une fois que vous avez créé une application, vous pouvez obtenir son secret d’application dans la page Paramètres du portail App Center. Dans le coin supérieur droit 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.

Notes

Dans la 4.0.0 version d’App Center, des changements cassants ont été introduits. Suivez la section Migrer vers app Center SDK 4.0.0 et versions ultérieures pour migrer App Center à partir des versions précédentes.

3.1 Intégration via Cocoapods

1. Ajoutez les dépendances suivantes à votre podfile pour inclure App Center Analytics et App Center Crashs dans votre application. Cette opération 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 s’appuient tous sur AppCenter. Il est automatiquement extrait.

    # 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 ouvrir le projet .xcworkspace.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le 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 Crashs dans votre application.

   # 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. Cette opération extrait les dépendances dans un dossier Carthage/Checkouts , puis génère chaque framework.

3. Ouvrez l’onglet Paramètres généraux de votre cible d’application. Faites glisser et déposez les fichiers AppCenter.framework, AppCenterAnalytics.framework et AppCenterCrashes.framework du dossier Carthage/Build/tvOS dans le Navigateur de projet de Xcode. AppCenter.framework est nécessaire 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 y ajouter les sdk App Center, car ils sont fournis en tant que frameworks statiques.

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

3.3 Intégration via le Gestionnaire de package Swift

1. Dans le menu Xcode, cliquez sur Fichier > Swift Packages > Ajouter une dépendance de package.
2. Dans la boîte de dialogue qui s’affiche, entrez l’URL du dépôt : https://github.com/microsoft/appcenter-sdk-apple.git.
3. Dans Version, sélectionnez Jusqu’à suivant majeur et utilisez l’option par défaut.
4. Choisissez les modules dont vous avez besoin dans la colonne Produit du package .

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

Notes

Si vous intégrez App Center via SwiftPM et que vous souhaitez également l’utiliser dans la cible d’extension de votre application, assurez-vous que vous fournissez DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES dans votre configuration. Cela est nécessaire pour éviter les limitations swiftPM lors de la liaison d’un module à plusieurs cibles.

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 afin de configurer App Center Analytics et app Center Crashs pour votre application tvOS.

Notes

Le Kit de développement logiciel (SDK) App Center prend en charge l’utilisation de XCframework. Si vous souhaitez intégrer XCframeworks à votre projet, téléchargez le AppCenter-SDK-Apple-XCFramework.zip à partir de la page des versions et décompressez-le. Le contenu du dossier résultant n’est pas spécifique à la plateforme, mais il contient plutôt des XCframeworks pour chaque module. Ils peuvent être intégrés de la même façon que les frameworks habituels, comme décrit ci-dessous.

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

2. Décompressez le fichier et vous verrez un dossier appelé AppCenter-SDK-Apple qui contient différents frameworks 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.

   • Comme bonne pratique, les bibliothèques tierces se trouvent généralement à l’intérieur d’un sous-répertoire (il est souvent appelé Fournisseur). Par conséquent, si votre projet n’est pas organisé avec un sous-répertoire pour les bibliothèques, créez un sous-répertoire Vendor maintenant.
   • Créez un groupe appelé Fournisseur dans 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 SDK App Center. Vous devrez donc peut-être supprimer les sous-dossiers dont vous n’avez pas besoin.

5. Ajoutez les frameworks sdk au projet dans Xcode :

   • Vérifiez que le Navigateur de projet est visible (⌘+1).
   • Maintenant, faites glisser AppCenter.framework, AppCenterAnalytics.framework et AppCenterCrashes.framework à partir du Finder (ceux qui se trouvent dans le dossier Vendor ) dans le Navigateur de projet de Xcode. AppCenter.framework est nécessaire pour démarrer le KIT de développement logiciel (SDK), assurez-vous qu’il est ajouté à votre projet. Sinon, les autres modules ne fonctionneront 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.

Remarque

Le fichier binaire du KIT de développement logiciel (SDK) n’est pas empaqueté conformément à la convention d’infrastructure tvOS. La raison en est que le Kit de développement logiciel (SDK) App Center pour tvOS n’est pas un framework conventionnel, mais un framework statique. Vous devez le lier en tant qu’infrastructure statique : assurez-vous que vous n’incorporez pas les fichiers binaires et ne les incluez pas dans la phase de génération « copier les ressources du bundle ».

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

4. Démarrer le KIT de développement logiciel (SDK)

Pour utiliser App Center, vous devez accepter 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 import

Ouvrez le fichier AppDelegate du projet et ajoutez les instructions import 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 didFinishLaunchingWithOptions l’application :

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

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

Avertissement

Il n’est pas recommandé d’incorporer votre secret d’application dans le code source.

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, case activée si l’App Center est déjà configuré.
3. Démarrez le ou les services requis sans le 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. Le secret de l’application se trouve dans la page Prise en main ou dans 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. Vous pouvez copier-coller l’exemple entier.

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

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 en tant que paramètre dans la méthode start, 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 enregistrent un avertissement dans la console et seuls les modules inclus dans le premier appel sont disponibles.

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

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

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

---

Très bien, vous êtes prêt à visualiser les données d’analyse et de plantage sur le portail que le KIT de développement logiciel (SDK) collecte automatiquement.

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