nativescript-watchos-connector

This is a NativeScript plugin that uses Apple WatchConnectivity to pass and receive data to a companion WatchOS app.

Prerequisites / Requirements

Before using this plugin, make sure you have followed the NativeScript blog post on Developing a watchOS Extension For Your NativeScript App and iOS WatchOS Applications.

Installation

Run the following command from the root of your project:

tns plugin add nativescript-watchos-connector

Usage

NativeScript Angular

1. For this plugin to work you must first add the nativescript-watchos-connector as a provider in your app.module.ts:

   TypeScript

   import { WatchOSConnector } from 'nativescript-watchos-connector'
   
   @NgModule({
     bootstrap: [AppComponent],
     imports: [],
     providers: [ WatchOSConnector ],
     declarations: [ AppComponent ],
     schemas: [ NO_ERRORS_SCHEMA ]
   })

2. Import the nativescript-watchos-connector plugin:

   TypeScript

   import { WatchOSConnector } from 'nativescript-watchos-connector'

3. Create an instance of the import in the constructor:

   TypeScript

   constructor(
    public watchOSConnector: WatchOSConnector
   )  {}

Plugin Overview

This is a list of all currently available functions and a brief description of their usage within this plugin.

Function	Description
createWCSession()	Creates a WCSession
watchOSChecker()	Checks if the user is on iOS, has an Apple Watch paired and the WatchOS app is installed
checkActivation()	Checks if the WCSession is active (if not, session will be activated)
convertInt(value)	Return value as Obj-C int
convertDouble(value)	Return value as Obj-C double
convertFloat(value)	Return value as Obj-C float
sendObjectToWatch('objectKey', object)	Send the data to the companion WatchOS App using ApplicationContext

createWCSession()

createWCSession checks if there the device can support a WCSession, if so a WCSession will be created.

TypeScript

this.watchOSConnector.createWCSession()

watchOSChecker()

Use watchOSChecker instead of isIOS when working with passing data to the Apple Watch. This checks if the user is on iOS, has an Apple Watch paired and the WatchOS app is installed (returns boolean)

TypeScript

if (this.watchOSConnector.watchOSChecker()) {
  // Only run if WatchOS app is avalaible
}

checkActivation()

Checks if the WCSession is active, if not this will activate the current session. This is called in sendObject() to ensure there is an active session.

TypeScript

this.watchOSConnector.checkActivation()

convertInt(value)

Returns the value as a NSNumber with int

TypeScript

this.watchOSConnector.convertInt(2319)

convertDouble(value)

Returns the value as a NSNumber with double

TypeScript

this.watchOSConnector.convertInt(42.957194)

convertFloat(value)

Returns the value as a NSNumber with float

TypeScript

this.watchOSConnector.convertInt(882.152)

sendObjectToWatch(objectKey, object)

Sends the data to the companion WatchOS app using updateApplicationContext. You need to pass in a key for the object and an object of Objective-C valid values.

TypeScript

let intValue = this.watchOSConnector.convertInt(4)
let doubleValue = this.watchOSConnector.convertDouble(45.1)

let numberObject = {
  convertedInt: intValue,
  convertedDouble: doubleValue
}

this.watchOSConnector.sendObject('numberObjectKey', numberObject)

Future Releases

• Assign received object from watch to an Observable
• JavaScript usage
• Add images to README

License

Apache License Version 2.0, January 2004