Inizio

1. Installa il pacchetto

   bun add @capgo/capacitor-watch

2. Sincronizza con i progetti nativi

   bunx cap sync

3. Configura il plugin

   Esempio di utilizzo base:

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

   Invia un messaggio a 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

   Configurazione iOS obbligatoria:

   1. Aggiungi la capacità WatchConnectivity al tuo'app iOS in Xcode
   2. Crea un obiettivo di app watchOS nel tuo progetto Xcode
   3. Implementa WatchConnectivity nell'app watchOS (vedi Implementazione dell'app Watch di seguito)

   Il plugin attiva automaticamente la WCSession quando il plugin si carica.

   Android

   L'Apple Watch è supportata solo su iOS. Su Android, tutti i metodi rifiuteranno con l'errore "Apple Watch è supportata solo su iOS". getInfo() Il metodo restituisce isSupported: false.

4. Gestisci messaggi che richiedono una risposta

   // 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. Sincronizza lo stato dell'applicazione

   // 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. Trasferisci informazioni utente in modo affidabile

   // 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. Monitora la connettività

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

Implementazione dell'app Watch

La tua app per watchOS deve implementare WatchConnectivity. Ecco un esempio di 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 Riferimento

Metodi

sendMessage(options: SendMessageOptions)

Invia un messaggio interattivo all'orologio. Richiede che l'orologio sia raggiungibile.

Parametri:

• data: Oggetto - I dati da inviare all'orologio

updateApplicationContext(options: UpdateContextOptions)

Aggiorna il contesto dell'applicazione. Solo l'ultima versione viene conservata.

Parametri:

• context: Oggetto - I dati del contesto da sincronizzare

transferUserInfo(options: TransferUserInfoOptions)

Inserisci in coda le informazioni dell'utente per una consegna affidabile.

Parametri:

• userInfo: Oggetto - Le informazioni dell'utente da trasferire

replyToMessage(options: ReplyMessageOptions)

Rispondi a un messaggio che richiede una risposta.

Parametri:

• callbackId: stringa - L'ID di callback dal messaggio ricevuto con l'evento messageReceivedWithReply
• data: Oggetto - I dati di risposta

getInfo()

Otteni lo stato di connettività della watch.

Restituisce: WatchInfo oggetto con:

• isSupported: boolean - Se WatchConnectivity è disponibile
• isPaired: boolean - Se un orologio è associato
• isWatchAppInstalled: boolean - Se l'applicazione orologio è installata
• isReachable: boolean - Se l'orologio è raggiungibile
• activationState: numero - Stato della sessione (0/1/2)

getPluginVersion()

Ottieni la versione del plugin nativo.

Eventi

Evento	Descrizione
messageReceived	Messaggio semplice dal watch
messageReceivedWithReply	Messaggio che aspetta una risposta (include callbackId)
applicationContextReceived	Aggiornamento di contesto dal watch
userInfoReceived	Trasferimento di informazioni dell'utente dal watch
reachabilityChanged	Cambiamento di connettività del watch
activationStateChanged	Lo stato di attivazione della sessione è cambiato

Modelli di comunicazione

Messaggistica immediata (sendMessage)sendMessage)

• Migliore per la comunicazione interattiva e a tempo di risposta
• Modelli di comunicazione
• Fails immediatamente se watch non è disponibile

Contexto dell'applicazione (updateApplicationContext)

• Ultimo valore solo - precedenti valori sovrascritti
• Migliore per sincronizzare lo stato corrente dell'applicazione
• Inviato quando watch diventa disponibile

Trasferimento di informazioni dell'utente (transferUserInfo)

• Inoltrato e inviato in ordine
• Migliore per dati importanti che devono essere inviati
• Funziona anche quando watch è temporaneamente inaccessibile

Note del sistema per piattaforma

iOS

• Richiede iOS 15.0 o successivo
• Utilizza il framework WatchConnectivity
• La sessione si attiva automaticamente al caricamento del plugin
• Supporta la consegna in background per contesto e informazioni utente

Android

• Non supportato (Apple Watch è disponibile solo per iOS)
• Tutti i metodi rifiutano con un errore appropriato
• getInfo() returns isSupported: false

Web

• Non supportato
• Tutti i metodi rifiutano con errore non disponibile
• getInfo() ritorna isSupported: false

Casi d'uso comuni

1. Sincronizzazione dei dati: Mantieni sincronizzati i dati del telefono e dell'orologio
2. Controllo remoto: Controlla le funzionalità del telefono dall'orologio
3. Notifiche: Inviare notifiche personalizzate al watch
4. Informazioni sulla salute: Condividi metriche di fitness e salute
5. Controllo Media: Controlla la riproduzione musicale dal watch
6. Casa intelligente: Controlla dispositivi dal polso

Risoluzione dei problemi

Watch non raggiungibile:

• Assicurati che il watch sia all'interno della portata Bluetooth
• Verifica che sia in esecuzione entrambi gli app
• Verifica che WCSession sia attivato su entrambi i lati

Non ricevuti messaggi:

• Controlla che i listener siano registrati prima di inviare
• Verifica che l'app orologio implementi WCSessionDelegate
• Usa transferUserInfo per una consegna garantita

Sessione non attiva:

• Assicurati che la capacità WatchConnectivity sia aggiunta in Xcode
• Controlla che l'app orologio abbia l'ID bundle del companion
• Verifica che entrambe le app puntino a versioni OS compatibili