Mulai Berlatar

Pemasangan

Kamu bisa menggunakan Setup Bantuan AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI kamu 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 kamu lebih suka Setup 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. Sinkron 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. Implementasi WatchConnectivity di aplikasi jam Anda (lihat Implementasi Jam di bawah ini)

   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 kembali isSupported: false.

4. Tangani pesan yang memerlukan jawaban

   // 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 status 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: Objek - Data yang akan dikirim ke jam tangan

updateApplicationContext(options: UpdateContextOptions)

Perbarui konteks aplikasi. Hanya nilai terbaru yang disimpan.

Parameter:

• context: Object - Data konteks untuk disinkronisasi

transferUserInfo(options: TransferUserInfoOptions)

Antar informasi pengguna untuk pengiriman yang dapat diandalkan.

Parameter:

• userInfo: Object - Informasi pengguna untuk ditransfer

replyToMessage(options: ReplyMessageOptions)

Balas pesan yang meminta respons.

Parameter:

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

getInfo()

Dapatkan 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
• activationState: number - Status sesi (0/1/2)

getPluginVersion()

Dapatkan versi plugin native.

Acara

Acara	Deskripsi
messageReceived	Pesan sederhana dari jam tangan
messageReceivedWithReply	Pesan yang menunggu balasan (termasuk callbackId)
applicationContextReceived	Pembaruan konteks dari jam tangan
userInfoReceived	Pindah data pengguna dari jam tangan
reachabilityChanged	Perubahan koneksi jam tangan
activationStateChanged	Perubahan status aktivasi sesi

Gaya Komunikasi

Pesan Langsung (sendMessage)

• Diperlukan agar jam tangan dapat dijangkau
• Paling cocok untuk komunikasi interaktif dan sensitif terhadap waktu
• Gagal segera jika jam tangan tidak tersedia

Konteks Aplikasi (updateApplicationContext)

• Nilai terbaru saja - nilai sebelumnya dihapus
• Paling cocok untuk sinkronisasi keadaan aplikasi saat ini
• Diterima ketika jam tangan tersedia

Pindah Data Pengguna (transferUserInfo)

• Ditambahkan dan dikirimkan dalam urutan
• Terbaik untuk data penting yang harus dikirimkan
• Bekerja bahkan ketika jam tangan tidak tersedia secara sementara

Catatan Platform

iOS

• Memerlukan iOS 15.0 atau lebih baru
• Menggunakan framework WatchConnectivity
• Sesi secara otomatis diaktifkan pada saat 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() mengembalikan isSupported: false

Web

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

Penggunaan Umum

1. Sinkronisasi Data: Pantau dan sinkronkan data ponsel
2. Remote Control: Kendalikan fitur ponsel dari jam tangan
3. Notifications: Kirim notifikasi kustom ke jam tangan
4. Health Data: Bagikan metrik kesehatan dan olahraga
5. Media Control: Kendalikan pemutaran musik dari jam tangan
6. Smart Home: Kendalikan perangkat dari lengan

Troubleshooting

Tonton tidak dapat dijangkau:

• Pastikan tontonan berada 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 tangan mengimplementasikan WCSessionDelegate
• Gunakan transferUserInfo untuk pengiriman yang dijamin

Sesi tidak aktif:

• Pastikan kemampuan WatchConnectivity ditambahkan di Xcode
• Pastikan aplikasi jam memiliki ID paket teman
• Verifikasi bahwa kedua aplikasi mengarah ke 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, Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugins oleh Capgo, Menambahkan atau Mengupdate Plugins untuk detail implementasi di Menambahkan atau Mengupdate Plugins, dan Alternatif Plugin Enterprise Ionic untuk alur produk di Alternatif Plugin Enterprise Ionic.