Getting Started

1. Installez le package

   bun add @capgo/capacitor-watch

2. Synchronisez les projets natifs

   bunx cap sync

3. Configurez le plugin

   Exemple de base d'utilisation :

   import { CapgoWatch } from '@capgo/capacitor-watch';
   
   // Check watch connectivity status
   const info = await CapgoWatch.getInfo();
   console.log('Watch paired:', info.isPaired);
   console.log('Watch reachable:', info.isReachable);
   
   // Listen for messages from watch
   await CapgoWatch.addListener('messageReceived', (event) => {
     console.log('Message from watch:', event.message);
   });

   Envoyer un message à Watch :

   // Check if watch is reachable first
   const info = await CapgoWatch.getInfo();
   if (info.isReachable) {
     await CapgoWatch.sendMessage({
       data: { action: 'refresh', timestamp: Date.now() }
     });
   }

   iOS

   Configuration requise iOS :

   1. Ajoutez la capacité WatchConnectivity à votre application iOS dans Xcode
   2. Créez une cible d'application watchOS dans votre projet Xcode
   3. Implémentez WatchConnectivity dans votre application watchOS (voir l'implémentation de l'application Watch ci-dessous)

   Le plugin active automatiquement la session WC lorsque le plugin charge.

   Android

   L'Apple Watch n'est pris en charge que sur iOS. Sur Android, toutes les méthodes rejettent avec l'erreur « Apple Watch n'est pris en charge que sur iOS ». getInfo() La méthode retourne isSupported: false.

4. Gérer les messages qui nécessitent une réponse

   // Listen for messages that need a response
   await CapgoWatch.addListener('messageReceivedWithReply', async (event) => {
     console.log('Request from watch:', event.message);
   
     // Process the request
     const result = await processWatchRequest(event.message);
   
     // Send reply back to watch
     await CapgoWatch.replyToMessage({
       callbackId: event.callbackId,
       data: { result }
     });
   });

5. Synchroniser l'état de l'application

   // Update application context (latest value only)
   await CapgoWatch.updateApplicationContext({
     context: {
       theme: 'dark',
       userId: '123',
       lastSync: Date.now()
     }
   });
   
   // Listen for context updates from watch
   await CapgoWatch.addListener('applicationContextReceived', (event) => {
     console.log('Context from watch:', event.context);
   });

6. Transférer les informations d'utilisateur de manière fiable

   // Queue data for reliable delivery (even when watch is offline)
   await CapgoWatch.transferUserInfo({
     userInfo: {
       recordId: '456',
       action: 'created',
       data: { name: 'Item 1' }
     }
   });
   
   // Listen for user info transfers
   await CapgoWatch.addListener('userInfoReceived', (event) => {
     console.log('User info from watch:', event.userInfo);
   });

7. Surveiller la connectivité

   // Track reachability changes
   await CapgoWatch.addListener('reachabilityChanged', (event) => {
     console.log('Watch reachable:', event.isReachable);
     if (event.isReachable) {
       // Watch is now available for interactive messaging
     }
   });
   
   // Track session activation state
   await CapgoWatch.addListener('activationStateChanged', (event) => {
     // 0 = notActivated, 1 = inactive, 2 = activated
     console.log('Session state:', event.state);
   });

Observer l'implémentation de l'application Watch

Votre application watchOS doit implémenter WatchConnectivity. Voici un exemple SwiftUI :

import SwiftUI
import WatchConnectivity

@main
struct MyWatchApp: App {
    init() {
        WatchViewModel.shared.activate()
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

class WatchViewModel: NSObject, ObservableObject, WCSessionDelegate {
    static let shared = WatchViewModel()

    @Published var lastMessage: [String: Any] = [:]

    func activate() {
        guard WCSession.isSupported() else { return }
        WCSession.default.delegate = self
        WCSession.default.activate()
    }

    // Send message to iPhone
    func sendToPhone(_ data: [String: Any]) {
        guard WCSession.default.isReachable else {
            print("iPhone not reachable")
            return
        }
        WCSession.default.sendMessage(data, replyHandler: nil)
    }

    // Send message with reply
    func sendToPhoneWithReply(_ data: [String: Any], completion: @escaping ([String: Any]) -> Void) {
        guard WCSession.default.isReachable else { return }
        WCSession.default.sendMessage(data, replyHandler: completion)
    }

    // Receive message from iPhone
    func session(_ session: WCSession, didReceiveMessage message: [String: Any]) {
        DispatchQueue.main.async {
            self.lastMessage = message
        }
    }

    // Receive application context
    func session(_ session: WCSession, didReceiveApplicationContext applicationContext: [String: Any]) {
        DispatchQueue.main.async {
            self.lastMessage = applicationContext
        }
    }

    // Required delegate methods
    func session(_ session: WCSession, activationDidCompleteWith activationState: WCSessionActivationState, error: Error?) {
        print("Watch session activated: \(activationState.rawValue)")
    }
}

API Référence

Méthodes

sendMessage(options: SendMessageOptions)

Envoyer un message interactif à l'horloge. Exige que l'horloge soit accessible.

Paramètres :

• data: Objet - Les données à envoyer à l'horloge

updateApplicationContext(options: UpdateContextOptions)

Met à jour le contexte de l'application. Seule la dernière valeur est conservée.

Paramètres :

• context: Objet - Les données de contexte à synchroniser

transferUserInfo(options: TransferUserInfoOptions)

Enfile les informations de l'utilisateur pour une livraison fiable.

Paramètres :

• userInfo: Objet - Les informations de l'utilisateur à transférer

replyToMessage(options: ReplyMessageOptions)

Répondre à un message qui a demandé une réponse.

Paramètres :

• callbackId: chaîne de caractères - L'ID de rappel du messageReceivedWithReply
• data: Objet - Les données de réponse

getInfo()

Obtenir l'état de la connectivité de l'horloge.

Retourne : WatchInfo objet avec :

• isSupported: boolean - Whether WatchConnectivity est disponible
• isPaired: boolean - Whether un montre est pairé
• isWatchAppInstalled: boolean - Whether l'application d'horloge est installée
• isReachable: boolean - Whether l'horloge est accessible
• activationState: nombre - État de session (0/1/2)

getPluginVersion()

Obtenez la version native du plugin.

Événements

Événement	Description
messageReceived	Message simple de l'horloge
messageReceivedWithReply	Message attendu en réponse (inclut callbackId)
applicationContextReceived	Mise à jour du contexte de l'horloge
userInfoReceived	Transfert d'informations de l'utilisateur de l'horloge
reachabilityChanged	État de la connectivité de l'horloge modifié
activationStateChanged	État d'activation de la session modifié

Modèles de communication

Messagerie immédiate (sendMessage)

• Exige que l'horloge soit accessible
• Meilleur pour la communication interactive et sensible à l'heure
• Echoue immédiatement si la surveillance n'est pas disponible

Contexte d'application (updateApplicationContext)

• Seulement la dernière valeur - les valeurs précédentes sont effacées
• Meilleur pour la synchronisation de l'état actuel de l'application
• Envoyé lorsque la montre devient disponible

Transfert d'informations de l'utilisateur (transferUserInfo)

• En file d'attente et envoyé dans l'ordre
• Meilleur pour les données importantes qui doivent être envoyées
• Marche même lorsque la montre est temporairement inatteignable

Notes de la plateforme

iOS

• Exige iOS 15.0 ou ultérieur
• Utilise le framework WatchConnectivity
• La session s'active automatiquement lors du chargement du plugin
• Supporte la livraison en arrière-plan pour le contexte et les informations utilisateur

Android

• Non pris en charge (l'Apple Watch est uniquement disponible sous iOS)
• Toutes les méthodes rejettent avec un erreur appropriée
• getInfo() retourne isSupported: false

Web

• Non pris en charge
• Toutes les méthodes rejettent avec une erreur non disponible
• getInfo() renvoie isSupported: false

Utilisations courantes

1. Synchronisation de données: Gardez les données de l'horloge et du téléphone synchronisées
2. Contrôle à distance: Contrôlez les fonctionnalités du téléphone à partir de l'horloge
3. Notifications: Envoyer des notifications personnalisées à l'horloge
4. Health Data: Partager les métriques de fitness et de santé
5. Media Control: Contrôler la lecture de musique depuis l'horloge
6. Smart Home: Contrôler les appareils depuis votre poignet

Troubleshooting

L'horloge n'est pas accessible :

• Vérifiez que l'horloge est dans la zone de couverture Bluetooth
• Vérifiez que les deux applications sont en cours d'exécution
• Vérifiez que WCSession est activé des deux côtés

Messages non reçus :

• Vérifiez que les écouteurs sont enregistrés avant d'envoyer
• Vérifiez que l'application horlogère implémente WCSessionDelegate
• Utilisez transferUserInfo pour une livraison garantie

Session non activée :

• Assurez-vous que la capacité WatchConnectivity est ajoutée dans Xcode
• Vérifiez que l'application horlogère a l'ID de bundle de l'application de compagnon
• Vérifiez que les deux applications ciblent des versions OS compatibles

Continuez de la section « Continuez de Getting Started »

Si vous utilisez Demarrage pour planifier le travail de plugin natif, connectez-le avec Utiliser @capgo/capacitor-watch pour la capacité native dans Utiliser @capgo/capacitor-watch, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou Mettre à jour les plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les plugins, et Alternatives de plugins d'entreprise Ionic Enterprise pour le flux de travail du produit dans les alternatives du plugin Enterprise Ionic.