Getting Started
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 지시를 복사하세요.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-watch`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/watch/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
-
__CAPGO_KEEP_4__
__CAPGO_KEEP_5__ bun add @capgo/capacitor-watch -
__CAPGO_KEEP_7__
__CAPGO_KEEP_8__ bunx cap sync -
__CAPGO_KEEP_10__
__CAPGO_KEEP_11__
import { CapgoWatch } from '@capgo/capacitor-watch';// Check watch connectivity statusconst info = await CapgoWatch.getInfo();console.log('Watch paired:', info.isPaired);console.log('Watch reachable:', info.isReachable);// Listen for messages from watchawait CapgoWatch.addListener('messageReceived', (event) => {console.log('Message from watch:', event.message);});Watch:로 메시지를 보냅니다.
// Check if watch is reachable firstconst info = await CapgoWatch.getInfo();if (info.isReachable) {await CapgoWatch.sendMessage({data: { action: 'refresh', timestamp: Date.now() }});}iOS에 필요한 설정:
- Xcode에서 iOS 앱에 WatchConnectivity 기능을 추가하세요.
- Xcode 프로젝트에서 watchOS 앱 대상 만들기
- watchOS 앱에서 WatchConnectivity 구현 (Watch App Implementation 참조)
플러그인은 플러그인이 로드될 때 자동으로 WCSession을 활성화합니다.
Apple Watch는 iOS에서만 지원됩니다. Android에서는 모든 메서드가 "iOS에서만 지원되는 Apple Watch" 오류로 거부됩니다.
getInfo()method returnsisSupported: false. -
답변을 필요로 하는 메시지 처리
// Listen for messages that need a responseawait CapgoWatch.addListener('messageReceivedWithReply', async (event) => {console.log('Request from watch:', event.message);// Process the requestconst result = await processWatchRequest(event.message);// Send reply back to watchawait CapgoWatch.replyToMessage({callbackId: event.callbackId,data: { result }});}); -
애플리케이션 상태 동기화
// Update application context (latest value only)await CapgoWatch.updateApplicationContext({context: {theme: 'dark',userId: '123',lastSync: Date.now()}});// Listen for context updates from watchawait CapgoWatch.addListener('applicationContextReceived', (event) => {console.log('Context from watch:', event.context);}); -
사용자 정보 신뢰성 있는 전송
// 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 transfersawait CapgoWatch.addListener('userInfoReceived', (event) => {console.log('User info from watch:', event.userInfo);}); -
네트워크 연결 모니터링
// Track reachability changesawait CapgoWatch.addListener('reachabilityChanged', (event) => {console.log('Watch reachable:', event.isReachable);if (event.isReachable) {// Watch is now available for interactive messaging}});// Track session activation stateawait CapgoWatch.addListener('activationStateChanged', (event) => {// 0 = notActivated, 1 = inactive, 2 = activatedconsole.log('Session state:', event.state);});
앱 구현
앱 구현watchOS 앱은 WatchConnectivity를 구현해야 합니다. SwiftUI 예제입니다.
import SwiftUIimport WatchConnectivity
@mainstruct 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 Reference
API Reference메서드
메서드sendMessage(options: SendMessageOptions)
sendMessage(options: SendMessageOptions)라는 제목의 섹션시계를 찾을 수 있는 경우 시계에 인터랙티브 메시지를 보내세요.
매개 변수:
data: Object - 시계로 보낼 데이터
updateApplicationContext(options: UpdateContextOptions)
updateApplicationContext(options: UpdateContextOptions)라는 제목의 섹션애플리케이션 컨텍스트를 업데이트하세요. 최신 값만 유지됩니다.
매개 변수:
context: Object - 동기화할 컨텍스트 데이터
transferUserInfo(options: TransferUserInfoOptions)
Section titled “사용자 정보 전송(transferUserInfo(options: TransferUserInfoOptions))”사용자 정보를 신뢰할 수 있는 전송으로 대기합니다.
매개 변수:
userInfo: Object - 전송할 사용자 정보
replyToMessage(options: ReplyMessageOptions)
Section titled “메시지에 대한 응답(replyToMessage(options: ReplyMessageOptions))”메시지에 대한 응답을 합니다.
매개 변수:
callbackId: string - messageReceivedWithReply 이벤트에서 받은 callback IDdata: Object - 응답 데이터
getInfo()
Section titled “정보 가져오기(getInfo())”watch 연결 상태를 가져옵니다.
반환 값: WatchInfo 객체에:
isSupported: boolean - WatchConnectivity가 사용 가능 여부isPaired: boolean - 시계가 pair된 여부isWatchAppInstalled: boolean - 시계 앱이 설치된 여부isReachable: boolean - 시계가 접근 가능한 여부activationState: number - 세션 상태 (0/1/2)
getPluginVersion()
버전 가져오기Section titled “getPluginVersion()”
| 이벤트 | 설명 |
|---|---|
messageReceived | __CAPGO_KEEP_0__ |
messageReceivedWithReply | __CAPGO_KEEP_1__ (callbackId) |
applicationContextReceived | __CAPGO_KEEP_2__ |
userInfoReceived | __CAPGO_KEEP_3__ |
reachabilityChanged | __CAPGO_KEEP_4__ |
activationStateChanged | __CAPGO_KEEP_5__ |
통신 방식
통신 방식즉시 메시징 (sendMessage)sendMessage)
__CAPGO_KEEP_6__- 시동이 필요한 상호 작용 및 시간에 민감한 통신
- 즉시 메시징 (sendMessage)
- __CAPGO_KEEP_0__이 즉시 실패합니다.
__CAPGO_KEEP_1__ (updateApplicationContext)
__CAPGO_KEEP_2__ (updateApplicationContext)- __CAPGO_KEEP_3__ - 이전 값은 덮어씌워집니다.
- __CAPGO_KEEP_4__를 위해 현재 앱 상태 동기화
- __CAPGO_KEEP_5__가 사용 가능해질 때
__CAPGO_KEEP_6__ (transferUserInfo)
__CAPGO_KEEP_7__ (transferUserInfo)- __CAPGO_KEEP_8__와 함께 큐에 넣어져 순서대로 전달됩니다.
- __CAPGO_KEEP_9__를 위해 중요한 데이터 전달
- __CAPGO_KEEP_10__가 임시로 사용할 수 없을 때도 작동합니다.
__CAPGO_KEEP_11__
플랫폼 참고 사항iOS
iOS- iOS 15.0 이상이 필요합니다
- WatchConnectivity 프레임워크 사용
- 플러그인 로드 시 세션 자동 활성화
- 컨텍스트 및 사용자 정보를 위한 배경 전달 지원
Android
Android- Apple Watch는 iOS 전용이므로 지원되지 않습니다
- 모든 메소드는 적절한 오류로 거부합니다
getInfo()returnsisSupported: false
__CAPGO_KEEP_0__
__CAPGO_KEEP_1__- __CAPGO_KEEP_2__
- __CAPGO_KEEP_3__
getInfo()__CAPGO_KEEP_4__isSupported: false
__CAPGO_KEEP_5__
__CAPGO_KEEP_6__- __CAPGO_KEEP_7____CAPGO_KEEP_8__
- __CAPGO_KEEP_9____CAPGO_KEEP_10__
- __CAPGO_KEEP_11__: __CAPGO_KEEP_0__을 사용하여 개인화된 알림을 시계로 전송하세요.
- 건강 데이터: 시계와 함께 운동 및 건강 지표를 공유하세요.
- 미디어 제어: 시계에서 음악 재생을 제어하세요.
- 스마트 홈: 손목에서 장치를 제어하세요.
문제 해결
문제 해결시계 접근 불가:
- 블루투스 범위 내에 시계가 있는지 확인하세요.
- 앱이 모두 실행 중인지 확인하세요.
- __CAPGO_KEEP_0__ 활성화 여부를 확인하세요.
__CAPGO_KEEP_1__을 받지 못했습니다.
- __CAPGO_KEEP_2__가 등록되어 있는지 확인하세요.
- __CAPGO_KEEP_0__를 구현하는 시계 앱을 확인하세요.
- __CAPGO_KEEP_3__
transferUserInfo__CAPGO_KEEP_4__를 보장합니다.
__CAPGO_KEEP_0__가 활성화되지 않았습니다.
- Xcode에서 WatchConnectivity 기능이 추가되어 있는지 확인하세요.
- 시계 앱이 동반 앱의 번들 ID를 가지고 있는지 확인하세요.
- __CAPGO_KEEP_0__와 __CAPGO_KEEP_0__가 호환 가능한 OS 버전을 대상으로 하고 있는지 확인하세요.
__CAPGO_KEEP_5__에서 계속하세요.
__CAPGO_KEEP_6__에서 계속하세요.If you are using __CAPGO_KEEP_0__ Getting Started native 플러그인 작업을 계획하는 경우 __CAPGO_KEEP_0__과 연결하세요. capgo/capacitor-watch를 사용하여 native 기능을 capgo/capacitor-watch에서 사용하세요. for the native capability in Using @capgo/capacitor-watch, Capgo 플러그인 디렉토리에서 제품 워크플로우를 사용하세요. Capgo 플러그인들에 의해 __CAPGO_KEEP_1__ Capacitor 플러그인들에 의해 Capgo에서 구현 세부 정보를 사용하세요. for the implementation detail in Capacitor Plugins by Capgo, 플러그인 추가 또는 업데이트에서 구현 세부 정보를 사용하세요. Ionic Enterprise 플러그인 대체품 __CAPGO_KEEP_0__ Capgo 제품 워크플로우에 대한 Ionic Enterprise 플러그인 대체 제품입니다.