Inicio

Instalación

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-watch` plugin in my project.

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

1. Instalar el paquete

   bun add @capgo/capacitor-watch

2. Sincronizar con proyectos nativos

   bunx cap sync

3. Configurar el complemento

   Ejemplo de uso básico:

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

   Enviar un mensaje 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

   Configuración requerida de iOS:

   1. Agregue la capacidad de WatchConnectivity a su aplicación de iOS en Xcode
   2. Cree una aplicación de destino de watchOS en su proyecto de Xcode
   3. Implemente WatchConnectivity en su aplicación de watchOS (consulte la implementación de la aplicación de reloj a continuación)

   El complemento activa automáticamente la sesión WC cuando se carga el complemento.

   Android

   El reloj de Apple solo se admite en iOS. En Android, todos los métodos rechazarán con el error "Apple Watch is only supported on iOS". getInfo() El método devuelve isSupported: false.

4. Gestione mensajes que requieren una respuesta

   // 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. Sync application state

   // 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. Transferir información de usuario de manera 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. Monitorear conectividad

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

Implementación de la aplicación de reloj

Su aplicación de reloj necesita implementar WatchConnectivity. Aquí hay un ejemplo de 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)")
    }
}

Referencia de API

Metodos

sendMessage(options: SendMessageOptions)

Enviar un mensaje interactivo al reloj. Requiere que el reloj esté disponible.

Parametros:

• data: Object - Los datos a enviar al reloj

updateApplicationContext(options: UpdateContextOptions)

Actualizar contexto de la aplicación. Solo el último valor se mantiene.

Parametros:

• context: Object - Los datos de contexto para sincronizar

transferUserInfo(options: TransferUserInfoOptions)

Cola la información del usuario para un envío confiable.

Parámetros:

• userInfo: Objeto - La información del usuario para transferir

replyToMessage(options: ReplyMessageOptions)

Responder a un mensaje que solicitó una respuesta.

Parámetros:

• callbackId: string - El ID de llamada de retorno desde el evento messageReceivedWithReply
• data: Objeto - Los datos de respuesta

getInfo()

Obtener el estado de conectividad de la reloj.

Devuelve: WatchInfo objeto con:

• isSupported: boolean - Si WatchConnectivity está disponible
• isPaired: boolean - ¿Está pairado un reloj
• isWatchAppInstalled: boolean - ¿Está instalado la aplicación del reloj
• isReachable: boolean - ¿Está disponible el reloj
• activationState: número - Estado de la sesión (0/1/2)

getPluginVersion()

Obtener la versión nativa del plugin

Eventos

Evento	Descripción
messageReceived	Mensaje simple del reloj
messageReceivedWithReply	Mensaje que espera una respuesta (incluye callbackId)
applicationContextReceived	Actualización de contexto desde el reloj
userInfoReceived	Transferencia de información del usuario desde el reloj
reachabilityChanged	Se ha cambiado la conectividad del reloj
activationStateChanged	Se ha cambiado el estado de activación de la sesión

Patrones de comunicación

Mensajería inmediata (sendMessage)sendMessage)

• Requiere que el reloj esté disponible
• Mejor para la comunicación interactiva y sensible al tiempo
• Fallará inmediatamente si el reloj no está disponible

Contexto de la aplicación (updateApplicationContext)

• Último valor solo - los valores anteriores se sobreescriben
• Mejor para sincronizar el estado de la aplicación actual
• Se entrega cuando el reloj se vuelva disponible

Transferencia de información del usuario (transferUserInfo)

• Programado y se entrega en orden
• Mejor para datos importantes que deben ser entregados
• Funciona incluso cuando el reloj esté temporalmente inalcanzable

Notas de la plataforma

iOS

• Requiere iOS 15.0 o posterior
• Utiliza el marco de trabajo WatchConnectivity
• La sesión se activa automáticamente al cargar el plugin
• Soporta entrega de fondo para contexto y información del usuario

Android

• No está soportado (Apple Watch es solo iOS)
• Todos los métodos rechazan con el error apropiado
• getInfo() devuelve isSupported: false

Web

• Not soportado
• Todas las métodos rechazan con error de no disponible
• getInfo() devuelve isSupported: false

Uso común

1. Sincronización de datos: Mantener sincronizados los datos del reloj y el teléfono
2. Control remoto: Controlar las características del teléfono desde el reloj
3. Notificaciones: Enviar notificaciones personalizadas al reloj
4. Datos de salud: Compartir métricas de fitness y salud
5. Control de medios: Controlar la reproducción de música desde el reloj
6. Hogar inteligente: Controlar dispositivos desde el antebrazo

Solución de problemas

El reloj no está accesible:

• Asegúrese de que el reloj esté dentro del rango de Bluetooth
• Verifique que ambas aplicaciones estén en ejecución
• Verifique que WCSession esté activado en ambos lados

Los mensajes no se reciben:

• Verifique que los oyentes estén registrados antes de enviar
• Verifique que la aplicación de reloj implemente WCSessionDelegate
• Usar transferUserInfo para entrega garantizada

No se activa la sesión:

• Asegúrese de que la capacidad de WatchConnectivity esté agregada en Xcode
• Verifique que la aplicación de reloj tenga el ID de paquete de compañero
• Verifique que ambas aplicaciones targeten versiones de OS compatibles

Siga adelante desde Getting Started

Si está utilizando Getting Started para planificar el trabajo de plugin nativo, conectarlo con Usando @capgo/capacitor-watch para la capacidad nativa en Usando @capgo/capacitor-watch, Directorio de Plugins de Capgo para el flujo de trabajo del producto en Directorio de Plugins de Capgo, Plugins de Capacitor por Capgo para el detalle de implementación en Plugins de Capacitor por Capgo, Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins, y Alternativas de Plugins de Empresa de Ionic para el flujo de trabajo del producto en Alternativas de Plugins de Empresa de Ionic.