@capgo/capacitor-watch 8.0.2

package/dist/docs.json

@@ -0,0 +1,847 @@
+{
+  "api": {
+    "name": "CapgoWatchPlugin",
+    "slug": "capgowatchplugin",
+    "docs": "Apple Watch communication plugin for Capacitor.\nProvides bidirectional messaging between iPhone and Apple Watch using WatchConnectivity.",
+    "tags": [
+      {
+        "text": "8.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "sendMessage",
+        "signature": "(options: SendMessageOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The message options",
+            "type": "SendMessageOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The message options"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the message is sent"
+          },
+          {
+            "name": "throws",
+            "text": "Error if the watch is not reachable or session is not active"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.sendMessage({\n  data: { action: 'refresh', timestamp: Date.now() }\n});\n```"
+          }
+        ],
+        "docs": "Send an interactive message to the watch.\nThe watch must be reachable for this to succeed.\nUse this for time-sensitive, interactive communication.",
+        "complexTypes": [
+          "SendMessageOptions"
+        ],
+        "slug": "sendmessage"
+      },
+      {
+        "name": "updateApplicationContext",
+        "signature": "(options: UpdateContextOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The context options",
+            "type": "UpdateContextOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The context options"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the context is updated"
+          },
+          {
+            "name": "throws",
+            "text": "Error if session is not active"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.updateApplicationContext({\n  context: { theme: 'dark', lastSync: Date.now() }\n});\n```"
+          }
+        ],
+        "docs": "Update the application context shared with the watch.\nOnly the latest context is kept - this overwrites any previous context.\nUse this for syncing app state that the watch needs to display.",
+        "complexTypes": [
+          "UpdateContextOptions"
+        ],
+        "slug": "updateapplicationcontext"
+      },
+      {
+        "name": "transferUserInfo",
+        "signature": "(options: TransferUserInfoOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The user info options",
+            "type": "TransferUserInfoOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The user info options"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the transfer is queued"
+          },
+          {
+            "name": "throws",
+            "text": "Error if session is not active"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.transferUserInfo({\n  userInfo: { recordId: '123', action: 'created' }\n});\n```"
+          }
+        ],
+        "docs": "Transfer user info to the watch.\nTransfers are queued and delivered in order, even if the watch is not currently reachable.\nUse this for important data that must be delivered reliably.",
+        "complexTypes": [
+          "TransferUserInfoOptions"
+        ],
+        "slug": "transferuserinfo"
+      },
+      {
+        "name": "replyToMessage",
+        "signature": "(options: ReplyMessageOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The reply options including the callbackId",
+            "type": "ReplyMessageOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The reply options including the callbackId"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the reply is sent"
+          },
+          {
+            "name": "throws",
+            "text": "Error if the callback ID is invalid or session is not active"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nCapgoWatch.addListener('messageReceivedWithReply', async (event) => {\n  const result = await processRequest(event.message);\n  await CapgoWatch.replyToMessage({\n    callbackId: event.callbackId,\n    data: { result }\n  });\n});\n```"
+          }
+        ],
+        "docs": "Reply to a message from the watch that requested a reply.\nUse this in response to the messageReceivedWithReply event.",
+        "complexTypes": [
+          "ReplyMessageOptions"
+        ],
+        "slug": "replytomessage"
+      },
+      {
+        "name": "getInfo",
+        "signature": "() => Promise<WatchInfo>",
+        "parameters": [],
+        "returns": "Promise<WatchInfo>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with watch connectivity info"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst info = await CapgoWatch.getInfo();\nif (info.isReachable) {\n  await CapgoWatch.sendMessage({ data: { ping: true } });\n}\n```"
+          }
+        ],
+        "docs": "Get information about the watch connectivity status.",
+        "complexTypes": [
+          "WatchInfo"
+        ],
+        "slug": "getinfo"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapgoWatch.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'messageReceived', listenerFunc: (event: MessageReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'messageReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: MessageReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst handle = await CapgoWatch.addListener('messageReceived', (event) => {\n  console.log('Message from watch:', event.message);\n});\n// Later: handle.remove();\n```"
+          }
+        ],
+        "docs": "Listen for messages received from the watch.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "MessageReceivedEvent"
+        ],
+        "slug": "addlistenermessagereceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'messageReceivedWithReply', listenerFunc: (event: MessageReceivedWithReplyEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'messageReceivedWithReply'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: MessageReceivedWithReplyEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.addListener('messageReceivedWithReply', async (event) => {\n  const response = await handleRequest(event.message);\n  await CapgoWatch.replyToMessage({\n    callbackId: event.callbackId,\n    data: response\n  });\n});\n```"
+          }
+        ],
+        "docs": "Listen for messages from the watch that require a reply.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "MessageReceivedWithReplyEvent"
+        ],
+        "slug": "addlistenermessagereceivedwithreply-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'applicationContextReceived', listenerFunc: (event: ContextReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'applicationContextReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: ContextReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.addListener('applicationContextReceived', (event) => {\n  console.log('Context from watch:', event.context);\n});\n```"
+          }
+        ],
+        "docs": "Listen for application context updates from the watch.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ContextReceivedEvent"
+        ],
+        "slug": "addlistenerapplicationcontextreceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'userInfoReceived', listenerFunc: (event: UserInfoReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'userInfoReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: UserInfoReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.addListener('userInfoReceived', (event) => {\n  console.log('User info from watch:', event.userInfo);\n});\n```"
+          }
+        ],
+        "docs": "Listen for user info transfers from the watch.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UserInfoReceivedEvent"
+        ],
+        "slug": "addlisteneruserinforeceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'reachabilityChanged', listenerFunc: (event: ReachabilityChangedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'reachabilityChanged'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: ReachabilityChangedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.addListener('reachabilityChanged', (event) => {\n  console.log('Watch reachable:', event.isReachable);\n});\n```"
+          }
+        ],
+        "docs": "Listen for watch reachability changes.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReachabilityChangedEvent"
+        ],
+        "slug": "addlistenerreachabilitychanged-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'activationStateChanged', listenerFunc: (event: ActivationStateChangedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name",
+            "type": "'activationStateChanged'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- Callback function",
+            "type": "(event: ActivationStateChangedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - Callback function"
+          },
+          {
+            "name": "returns",
+            "text": "Handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.addListener('activationStateChanged', (event) => {\n  console.log('Activation state:', event.state);\n});\n```"
+          }
+        ],
+        "docs": "Listen for session activation state changes.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ActivationStateChangedEvent"
+        ],
+        "slug": "addlisteneractivationstatechanged-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapgoWatch.removeAllListeners();\n```"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "SendMessageOptions",
+      "slug": "sendmessageoptions",
+      "docs": "Options for sending a message to the watch.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [],
+          "docs": "The data to send to the watch.\nMust be serializable (string, number, boolean, arrays, or nested objects).",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "UpdateContextOptions",
+      "slug": "updatecontextoptions",
+      "docs": "Options for updating the application context.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "context",
+          "tags": [],
+          "docs": "The context data to sync with the watch.\nOnly the latest context is kept - previous values are overwritten.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "TransferUserInfoOptions",
+      "slug": "transferuserinfooptions",
+      "docs": "Options for transferring user info.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userInfo",
+          "tags": [],
+          "docs": "The user info data to transfer.\nTransfers are queued and delivered in order.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "ReplyMessageOptions",
+      "slug": "replymessageoptions",
+      "docs": "Options for replying to a message from the watch.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "callbackId",
+          "tags": [],
+          "docs": "The callback ID received in the messageReceivedWithReply event.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "data",
+          "tags": [],
+          "docs": "The reply data to send back to the watch.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "WatchInfo",
+      "slug": "watchinfo",
+      "docs": "Information about Watch connectivity status.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isSupported",
+          "tags": [],
+          "docs": "Whether WatchConnectivity is supported on this device.\nAlways false on iPad, web, and Android.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isPaired",
+          "tags": [],
+          "docs": "Whether an Apple Watch is paired with this iPhone.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isWatchAppInstalled",
+          "tags": [],
+          "docs": "Whether the paired watch has the companion app installed.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isReachable",
+          "tags": [],
+          "docs": "Whether the watch is currently reachable for immediate messaging.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "activationState",
+          "tags": [],
+          "docs": "The current activation state of the WCSession.\n0 = notActivated, 1 = inactive, 2 = activated",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "MessageReceivedEvent",
+      "slug": "messagereceivedevent",
+      "docs": "Event data for received messages.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "The message data received from the watch.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "MessageReceivedWithReplyEvent",
+      "slug": "messagereceivedwithreplyevent",
+      "docs": "Event data for messages that require a reply.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "The message data received from the watch.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        },
+        {
+          "name": "callbackId",
+          "tags": [],
+          "docs": "The callback ID to use when replying with replyToMessage().",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ContextReceivedEvent",
+      "slug": "contextreceivedevent",
+      "docs": "Event data for application context updates.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "context",
+          "tags": [],
+          "docs": "The context data received from the watch.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "UserInfoReceivedEvent",
+      "slug": "userinforeceivedevent",
+      "docs": "Event data for user info transfers.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userInfo",
+          "tags": [],
+          "docs": "The user info data received from the watch.",
+          "complexTypes": [
+            "WatchMessageData"
+          ],
+          "type": "WatchMessageData"
+        }
+      ]
+    },
+    {
+      "name": "ReachabilityChangedEvent",
+      "slug": "reachabilitychangedevent",
+      "docs": "Event data for reachability changes.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isReachable",
+          "tags": [],
+          "docs": "Whether the watch is now reachable.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ActivationStateChangedEvent",
+      "slug": "activationstatechangedevent",
+      "docs": "Event data for activation state changes.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "state",
+          "tags": [],
+          "docs": "The new activation state.\n0 = notActivated, 1 = inactive, 2 = activated",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "WatchMessageData",
+      "slug": "watchmessagedata",
+      "docs": "Data that can be sent between iPhone and Apple Watch.\nValues must be serializable (string, number, boolean, arrays, or nested objects).",
+      "types": [
+        {
+          "text": "Record<string, unknown>",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}