Framework

WatchConnectivity

Coordinate activities between your iOS app and your corresponding Watch app.

Overview

The Watch Connectivity framework (WatchConnectivity.framework) provides a two-way communications conduit between an iOS app and a WatchKit extension on a paired Apple Watch. Apps use this framework to pass files and data back and forth. Most transfers happen in the background when the receiving app is inactive. When the app wakes up, it is notified of any data that arrived while it was inactive. Live communication is also possible when both apps are active.

Symbols

Classes

WCSession

The WCSession class facilitates communication between a WatchKit extension and its companion iOS app. Both processes must create and configure an instance of this class at some point during their execution. When both session objects are active, the two processes can communicate immediately by sending messages back and forth. When only one session is active, the active session may still send updates and transfer files, but those transfers happen opportunistically in the background.

WCSessionFile

A WCSessionFile object encompasses information about a file being transferred between counterpart apps. The object includes the URL of the file on the local system and an optional dictionary of keys and values that accompany the file.

WCSessionFileTransfer

A WCSessionFileTransfer object stores information about in-progress file transfers. You do not create instances of this class yourself. When you initiate a file transfer, the system creates a new file transfer object to represent the transferred file. Use that object to get the file information or to cancel the transfer as needed.

WCSessionUserInfoTransfer

A WCSessionUserInfoTransfer object stores information about in-progress data transfers. You do not create instances of this class yourself. When you begin a data transfer, the system creates a new instance of this class for you. Use the created object to monitor or cancel the transfer as needed.

Protocols

WCSessionDelegate

The WCSessionDelegate protocol defines methods for responding to messages sent by a WCSession object. Session objects are used to communicate between a WatchKit extension and the companion iOS app on a paired and active iPhone. When configuring your session object, you must specify a delegate object that implements this protocol. The session calls your delegate methods to deliver incoming data from the counterpart app and to manage session-related changes.

Structures

Extended Types