Watch status

These properties tell you what the Session can do right now. Each read returns the current value, and they never throw.

Three of them have an event that fires when the value changes: onReachabilityChanged, onWatchPairedChanged and onWatchAppInstallChanged.

import { useEvent } from "expo";
import RnWatchConnect from "rn-watch-connect";

export function ReachabilityBadge() {
  const { isWatchReachable } = useEvent(RnWatchConnect, "onReachabilityChanged", {
    isWatchReachable: RnWatchConnect.isWatchReachable,
  });
  return isWatchReachable ? "Watch reachable" : "Watch not reachable";
}

isWatchSupportedCopy Anchor Link

readonly isWatchSupported: boolean

true when this iPhone supports WatchConnectivity. It's false on an iPad, and on platforms other than iOS. Check it before showing any Watch features.

Example

import RnWatchConnect from "rn-watch-connect";

if (!RnWatchConnect.isWatchSupported) {
  // Hide your Watch features.
}

isWatchPairedCopy Anchor Link

readonly isWatchPaired: boolean

true when an Apple Watch is paired with this iPhone. Listen to onWatchPairedChanged for changes. It's false on platforms other than iOS.

isWatchAppInstalledCopy Anchor Link

readonly isWatchAppInstalled: boolean

true when your Watch app is installed on the paired Watch. Listen to onWatchAppInstallChanged for changes. It's false on platforms other than iOS.

isWatchReachableCopy Anchor Link

readonly isWatchReachable: boolean

true when your Watch app can receive a Message right now, because it's running and in range. Only Messages and Data Messages need it: sending one while it's false fails with ERR_WATCH_NOT_REACHABLE. Application Context, User Info and File Transfers are delivered later instead. Listen to onReachabilityChanged for changes. It's false on platforms other than iOS.

Example

import RnWatchConnect from "rn-watch-connect";

if (RnWatchConnect.isWatchReachable) {
  await RnWatchConnect.sendMessageWithoutReply({ refresh: true });
} else {
  RnWatchConnect.transferUserInfo({ refresh: true });
}

watchActivationStateCopy Anchor Link

readonly watchActivationState: WatchActivationState
// "notActivated" | "inactive" | "activated" | "unknown"

Whether the Session is ready to carry data.

The Session activates when the library loads. There's no event for a failed activation: if watchActivationState still isn't "activated" shortly after launch, activation failed.

Example

import RnWatchConnect from "rn-watch-connect";

setTimeout(() => {
  if (RnWatchConnect.watchActivationState !== "activated") {
    console.warn("The Session didn't activate:", RnWatchConnect.watchActivationState);
  }
}, 2000);

onReachabilityChangedCopy Anchor Link

onReachabilityChanged: (event: { isWatchReachable: boolean }) => void

Fires when isWatchReachable changes. It fires only on a real change, so read the property for the starting value.

Event

Example

import { useEventListener } from "expo";
import RnWatchConnect from "rn-watch-connect";

export function ReachabilityLogger() {
  useEventListener(RnWatchConnect, "onReachabilityChanged", ({ isWatchReachable }) => {
    console.log("Watch reachable:", isWatchReachable);
  });
  return null;
}

onWatchPairedChangedCopy Anchor Link

onWatchPairedChanged: (event: { isWatchPaired: boolean }) => void

Fires when isWatchPaired changes. It fires only on a real change, so read the property for the starting value.

Event

Example

import { useEvent } from "expo";
import RnWatchConnect from "rn-watch-connect";

export function PairedStatus() {
  const { isWatchPaired } = useEvent(RnWatchConnect, "onWatchPairedChanged", {
    isWatchPaired: RnWatchConnect.isWatchPaired,
  });
  return isWatchPaired ? "Watch paired" : "No Watch paired";
}

onWatchAppInstallChangedCopy Anchor Link

onWatchAppInstallChanged: (event: { isWatchAppInstalled: boolean }) => void

Fires when isWatchAppInstalled changes. It fires only on a real change, so read the property for the starting value.

Event

Example

import { useEvent } from "expo";
import RnWatchConnect from "rn-watch-connect";

export function WatchAppStatus() {
  const { isWatchAppInstalled } = useEvent(RnWatchConnect, "onWatchAppInstallChanged", {
    isWatchAppInstalled: RnWatchConnect.isWatchAppInstalled,
  });
  return isWatchAppInstalled ? "Watch app installed" : "Install the Watch app";
}