Class

CXCall

A telephony call.

Declaration

class CXCall : NSObject

Overview

You don’t instantiate CXCall objects directly. Instead, CXCall objects are created by the telephony provider when an incoming call is received or an outgoing call is initiated.

Each CXCall object is uniquely identified by a uuid. You primarily interact with calls by passing their unique identifiers to CallKit APIs. For example, to place a call on hold, you create an instance of CXSetHeldCallAction with init(call:onHold:) passing the uuid of the call and true, create a CXTransaction object containing the action, and then pass the transaction to an instance of CXCallController using the request(_:completion:) method.

You can use the CXCallObserver managed by a CXCallController to access CXCall instances for active calls using the calls property, or provide an object conforming to the CXCallObserverDelegate protocol to be notified anytime a call is updated.

Topics

Accessing Call Attributes

var uuid: UUID

The unique identifier for the call.

var isOutgoing: Bool

A Boolean value that indicates whether the call is outgoing.

var hasConnected: Bool

A Boolean value that indicates whether the call has connected.

var hasEnded: Bool

A Boolean value that indicates whether the call has ended.

var isOnHold: Bool

A Boolean value that indicates whether the call is on hold.

Relationships

Inherits From

Conforms To

See Also

Call Information

class CXCallObserver

A programmatic interface for an object that manages a list of active calls and observes call changes.

protocol CXCallObserverDelegate

A collection of methods that are called by a call observer object when a call changes state.

class CXHandle

A means by which a call recipient can be reached, such as a phone number or email address.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software