Skip to main content
The Phone class represents a connected iPhone and provides methods for controlling it. You access phones through the TapKitClient.

Getting a Phone

Single Phone

When you have one phone connected, use get_phone():
get_phone() raises an error if you have zero or multiple phones. Use list_phones() or phone() for more control.

Multiple Phones

List all available phones:
Get a specific phone by name or ID:

Setting a Default Phone

Set a default phone for the client session:

Phone Properties

Screen Property

Every phone has a screen property with helpful coordinate utilities:
See Geometry for more screen utilities.

Executing Actions

The Phone object provides methods for all actions:
All action methods return a Job object with status information:

Phone Resolution

When calling client methods, the SDK resolves which phone to use:
  1. Explicit phone_id - If passed to the method
  2. Client default - Set via use_phone()
  3. Auto-select - If exactly one phone exists
  4. Error - If ambiguous

Next Steps

Screenshots

Capture screenshots from your phone

Gestures

Learn about tap, swipe, and other gestures