Pembelajaran Awal

Pemasangan

Anda dapat menggunakan Pengaturan Bantu AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

1. Instal paket

   bun add @capgo/capacitor-watch

2. Sinkronisasi dengan Proyek Asli

   bunx cap sync

3. Konfigurasi Plugin

   Contoh Penggunaan Dasar:

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

   Kirim Pesan ke 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

   Pengaturan iOS yang Diperlukan:

   1. Tambahkan kemampuan WatchConnectivity ke aplikasi iOS Anda di Xcode
   2. Buat target aplikasi watchOS di proyek Xcode Anda
   3. Implementasikan WatchConnectivity di aplikasi watchOS Anda (lihat Implementasi Aplikasi Jam di bawah)

   Plugin ini secara otomatis mengaktifkan WCSession ketika plugin dimuat.

   Android

   Apple Watch hanya didukung pada iOS. Pada Android, semua metode akan menolak dengan pesan kesalahan “Apple Watch hanya didukung pada iOS”. getInfo() Metode ini mengembalikan isSupported: false.

4. Tangani pesan yang memerlukan balasan

   // 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. Sinkronkan keadaan aplikasi

   // 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. Transfer informasi pengguna secara andal

   // 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. Monitor koneksi

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

Implementasi Aplikasi Jam Tangan

Aplikasi jam tangan Anda harus mengimplementasikan WatchConnectivity. Berikut adalah contoh 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 Referensi

Metode

sendMessage(options: SendMessageOptions)

Kirim pesan interaktif ke jam tangan. Memerlukan jam tangan untuk dapat dijangkau.

Parameter:

• data: Object - Data yang dikirim ke jam tangan

updateApplicationContext(options: UpdateContextOptions)

Perbarui konteks aplikasi. Hanya nilai terbaru yang disimpan.

Parameter:

• context: Object - Data konteks untuk disinkronkan

transferUserInfo(options: TransferUserInfoOptions)

Antar informasi pengguna untuk pengiriman yang dapat diandalkan.

Parameter:

• userInfo: Object - Informasi pengguna untuk ditransfer

replyToMessage(options: ReplyMessageOptions)

Mengirim balasan ke pesan yang meminta tanggapan.

Parameter:

• callbackId: string - ID panggilan balik dari event messageReceivedWithReply
• data: Object - Data balasan

getInfo()

Mendapatkan status koneksi jam tangan.

Mengembalikan: WatchInfo objek dengan:

• isSupported: boolean - Apakah WatchConnectivity tersedia
• isPaired: boolean - Apakah jam tangan terpasang
• isWatchAppInstalled: boolean - Apakah aplikasi jam tangan terinstal
• isReachable: boolean - Apakah jam tangan dapat dijangkau
• activationStateNomor - Status Sesi (0/1/2)

getPluginVersion()

Peroleh Versi Plugin Natively.

Event

Event	Deskripsi
messageReceived	Pesan Sederhana dari Watch
messageReceivedWithReply	Pesan Mengharapkan Balasan (termasuk callbackId)
applicationContextReceived	Pembaruan Konteks dari Watch
userInfoReceived	Pengiriman Informasi Pengguna dari Watch
reachabilityChanged	Perubahan Koneksi Watch
activationStateChanged	Status aktivasi sesi berubah

Gaya Komunikasi

Pengiriman Langsung (sendMessage)

• Diperlukan untuk mengetahui apakah jam tangan tersedia
• Terbaik untuk komunikasi interaktif dan sensitif waktu
• Gagal segera jika jam tangan tidak tersedia

Konteks Aplikasi (updateApplicationContext)

• Hanya nilai terbaru - nilai sebelumnya dihapus
• Terbaik untuk sinkronisasi status aplikasi saat ini
• Diterima ketika jam tangan tersedia

Pindah Data Pengguna (transferUserInfo)

• Ditambahkan dan diterima dalam urutan
• Paling cocok untuk data penting yang harus diterima
• Bekerja bahkan ketika jam tangan tidak tersedia sementara

Catatan Platform

iOS

• Memerlukan iOS 15.0 atau lebih baru
• Menggunakan framework WatchConnectivity
• Aktivasi sesi secara otomatis ketika plugin dimuat
• Mendukung pengiriman latar belakang untuk konteks dan informasi pengguna

Android

• Tidak didukung (Apple Watch hanya iOS)
• Semua metode menolak dengan kesalahan yang sesuai
• getInfo() returns isSupported: false

Web

• Tidak didukung
• Semua metode menolak dengan kesalahan tidak tersedia
• getInfo() returns isSupported: false

Penggunaan Umum

1. Sinkronisasi Data: Sinkronkan data ponsel dan jam tangan
2. Kontrol Jarak Jauh: Kontrol fitur ponsel dari jam tangan
3. Pemberitahuan: Kirim pemberitahuan kustom ke jam tangan
4. Data Kesehatan: Bagikan metrik kesehatan dan kebugaran
5. Kontrol Media: Kontrol pemutaran musik dari jam tangan
6. Rumah CerdasKontrol perangkat dari lengan Anda

Pengaturan

Jam tidak terjangkau:

• Pastikan jam dalam jangkauan Bluetooth
• Periksa bahwa kedua aplikasi berjalan
• Verifikasi WCSession diaktifkan di kedua sisi

Pesan tidak diterima:

• Periksa bahwa pendengar telah terdaftar sebelum mengirim
• Verifikasi aplikasi jam mengimplementasikan WCSessionDelegate
• Gunakan transferUserInfo untuk pengiriman yang dijamin

Sesi tidak aktif:

• Pastikan kemampuan WatchConnectivity ditambahkan di Xcode
• Periksa bahwa aplikasi jam memiliki ID paket kompanen
• Verifikasi bahwa kedua aplikasi targetkan versi OS yang kompatibel

Lanjutkan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-watch untuk kemampuan native di Menggunakan @capgo/capacitor-watch Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.