FCXCallUpdate class
Dart representation of CXCallUpdate from iOS CallKit Framework.
An encapsulation of new and changed information about a call.
FCXCallUpdate objects are used by the system to communicate changes to calls over time.
Not every property on a FCXCallUpdate object must be set each time, as each object includes only new and changed information. For example, when a call is started, only some properties may be known and included in the first FCXCallUpdate object sent to the system, such as localizedCallerName. Later in the same call, other properties may change; for example, a call may be upgraded from audio only to audio and video, which would be reflected by a new FCXCallUpdate object with its hasVideo property set to true.
When an incoming call is received, you construct a FCXCallUpdate object specifying a localizedCallerName and pass that to the FCXProvider.reportNewIncomingCall method to notify the telephony provider.
When an active call is updated, you construct a FCXCallUpdate object specifying any updated information and pass that to the FCXProvider.reportCallUpdated method.
For example, if a user changes their contact information during a call, you could notify the telephony provider of this change using a new FCXCallUpdate object with the new value set to its remoteHandle property.
Any property that is not set will be ignored.
Constructors
- FCXCallUpdate({FCXHandle? remoteHandle, String? localizedCallerName, bool supportsHolding = false, bool supportsGrouping = false, bool supportsUngrouping = false, bool supportsDTMF = false, bool hasVideo = false})
- Creates FCXCallUpdate instance.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasVideo ↔ bool
-
The call includes video in addition to audio.
getter/setter pair
- localizedCallerName ↔ String?
-
Override the computed caller name to a provider-defined value.
Normally the system will determine the appropriate caller name
to display (e.g. using the user's contacts) based on the
supplied caller identifier. Set this property to customize.
getter/setter pair
- remoteHandle ↔ FCXHandle?
-
The handle for the remote party (for an incoming call, this is the caller;
for an outgoing call, this is the callee).
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- supportsDTMF ↔ bool
-
The call can send DTMF (dual tone multifrequency) tones
via hard pause digits or in-call keypad entries.
getter/setter pair
- supportsGrouping ↔ bool
-
Whether the call can be grouped (merged)
with other calls when it is ungrouped.
getter/setter pair
- supportsHolding ↔ bool
-
Whether the call can be held on its own or swapped with another call.
getter/setter pair
- supportsUngrouping ↔ bool
-
The call can be ungrouped (taken private) when it is grouped.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited