Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: fix typo in CapacitorWatch #95

Merged
merged 2 commits into from
Jun 27, 2024
Merged

refactor!: fix typo in CapacitorWatch #95

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
493cc2d
refactor!: fix typo in CapacitorWatch
jcesarmobile Jun 27, 2024
d7babc9
adding changeset
theproducer Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,21 +492,21 @@ Get access to device location information.
| **`heading`** | <code>number \| null</code> | The heading the user is facing (if available) | 1.0.0 |


#### CapcacitorWatch
#### CapacitorWatch

Interact with a watch paired with this app

sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
They could be used if a native watch app is developed as a companion app to a Capacitor app

| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |
| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |


</capacitor-api-docs>
18 changes: 9 additions & 9 deletions packages/capacitor-plugin/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,20 +97,20 @@ Get access to device location information.
| **`heading`** | <code>number \| null</code> | The heading the user is facing (if available) | 1.0.0 |


#### CapcacitorWatch
#### CapacitorWatch

Interact with a watch paired with this app

sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
They could be used if a native watch app is developed as a companion app to a Capacitor app

| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |
| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |

</docgen-api>
18 changes: 9 additions & 9 deletions packages/capacitor-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,21 +492,21 @@ Get access to device location information.
| **`heading`** | <code>number \| null</code> | The heading the user is facing (if available) | 1.0.0 |


#### CapcacitorWatch
#### CapacitorWatch

Interact with a watch paired with this app

sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
They could be used if a native watch app is developed as a companion app to a Capacitor app

| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a CapacitorWatch watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |
| Prop | Type | Description |
| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`sendMessage`** | <code>(options: []) =&gt; void</code> | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`transferUserInfo`** | <code>(options: []) =&gt; void</code> | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code> | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
| **`isReachable`** | <code>boolean</code> | Checks to see if the compaion watch is reachable |
| **`updateWatchUI`** | <code>(options: { watchUI: string; }) =&gt; void</code> | Replaces the current UI on the watch with what is specified here. |
| **`updateWatchData`** | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields |


</capacitor-api-docs>
4 changes: 2 additions & 2 deletions packages/capacitor-plugin/src/apis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ export interface CapacitorNotifications {
* sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
* They could be used if a native watch app is developed as a companion app to a Capacitor app
*/
export interface CapcacitorWatch {
export interface CapacitorWatch {
/**
* Sends a message to the watch with the sendMessage() WCSession delegate method
*
Expand Down Expand Up @@ -365,5 +365,5 @@ export interface CapacitorAPI {
CapacitorKV: CapacitorKV;
CapacitorNotifications: CapacitorNotifications;
CapacitorGeolocation: CapacitorGeolocation;
CapacitorWatch: CapcacitorWatch;
CapacitorWatch: CapacitorWatch;
}
Loading