FCXProvider class

Dart representation of CXProvider from iOS CallKit Framework.

A FCXProvider object is responsible for reporting out-of-band notifications that occur to the system.

A VoIP app should create only one instance of FCXProvider and store it for use globally.

A FCXProvider object is initialized with a FCXProviderConfiguration object to specify the behavior and capabilities of calls.

Each provider has callbacks to respond to events, such as the call starting, the call being put on hold, or the provider’s audio session being activated.

A FCXProvider object is ready to use after initialized and configured using configure.

FCXProvider is not intended for subclassing.

Constructors

FCXProvider()
factory

Properties

configuration FCXProviderConfiguration
The configuration of the provider. To change the configuration use FCXProvider.configure.
read-only
executeTransaction FCXExecuteTransaction
Callback for getting notified when a transaction is executed by a call controller.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
performAnswerCallAction FCXPerformAnswerCallAction
Callback for getting notified when the provider performs the specified answer call action.
read / write
performEndCallAction FCXPerformEndCallAction
Callback for getting notified when the provider performs the specified end call action.
read / write
performPlayDTMFCallAction FCXPerformPlayDTMFCallAction
Callback for getting notified when the provider performs the specified play DTMF (dual tone multifrequency) call action.
read / write
performSetGroupCallAction FCXPerformSetGroupCallAction
Callback for getting notified when the provider performs the specified set group call action.
read / write
performSetHeldCallAction FCXPerformSetHeldCallAction
Callback for getting notified when the provider performs the specified set held call action.
read / write
performSetMutedCallAction FCXPerformSetMutedCallAction
Callback for getting notified when the provider performs the specified set muted call action.
read / write
performStartCallAction FCXPerformStartCallAction
Callback for getting notified when the provider performs the specified start call action.
read / write
providerDidActivateAudioSession FCXProviderDidActivateAudioSession
Callback for getting notified when the provider’s audio session is activated.
read / write
providerDidBegin FCXProviderDidBegin
Callback for getting notified when the provider begins.
read / write
providerDidDeactivateAudioSession FCXProviderDidDeactivateAudioSession
Callback for getting notified when the provider’s audio session is deactivated.
read / write
providerDidReset FCXProviderDidReset
Callback for getting notified when the provider is reset.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
timedOutPerformingAction FCXTimedOutPerformingAction
Callback for getting notified when the provider performs the specified action times out.
read / write

Methods

configure(FCXProviderConfiguration configuration) Future<void>
Configure provider with the specified configuration.
getPendingTransactions() Future<List<FCXTransaction>>
Returns all transactions that are not yet completed.
invalidate() Future<void>
Invalidates the provider and completes all active calls with an error. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
reportCallEnded(String uuid, DateTime dateEnded, FCXCallEndedReason endedReason) Future<void>
Reports to the provider that a call with the specified identifier ended at a given date for a particular reason. [...]
reportCallUpdated(String uuid, FCXCallUpdate update) Future<void>
Reports to the provider that an active call updated its information. [...]
reportNewIncomingCall(String uuid, FCXCallUpdate update) Future<void>
Report a new incoming call to the system. [...]
reportOutgoingCall(String uuid, DateTime dateStartedConnecting) Future<void>
Reports to the provider that an outgoing call with the specified unique identifier started connecting at a particular time. [...]
reportOutgoingCallConnected(String uuid, DateTime dateConnected) Future<void>
Reports to the provider that an outgoing call with the specified unique identifier finished connecting at a particular time. [...]
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited