Interface CXProviderDelegate


  • public interface CXProviderDelegate
    API-Since: 10.0
    • Method Detail

      • providerDidActivateAudioSession

        default void providerDidActivateAudioSession​(@NotNull
                                                     @NotNull CXProvider provider,
                                                     @NotNull
                                                     @NotNull AVAudioSession audioSession)
        Called when the provider's audio session activation state changes.
      • providerDidDeactivateAudioSession

        default void providerDidDeactivateAudioSession​(@NotNull
                                                       @NotNull CXProvider provider,
                                                       @NotNull
                                                       @NotNull AVAudioSession audioSession)
      • providerExecuteTransaction

        default boolean providerExecuteTransaction​(@NotNull
                                                   @NotNull CXProvider provider,
                                                   @NotNull
                                                   @NotNull CXTransaction transaction)
        Called whenever a new transaction should be executed. Return whether or not the transaction was handled: - NO: the transaction was not handled indicating that the perform*CallAction methods should be called sequentially for each action in the transaction - YES: the transaction was handled and the perform*CallAction methods should not be called sequentially If the method is not implemented, NO is assumed.
      • providerPerformAnswerCallAction

        default void providerPerformAnswerCallAction​(@NotNull
                                                     @NotNull CXProvider provider,
                                                     @NotNull
                                                     @NotNull CXAnswerCallAction action)
      • providerPerformEndCallAction

        default void providerPerformEndCallAction​(@NotNull
                                                  @NotNull CXProvider provider,
                                                  @NotNull
                                                  @NotNull CXEndCallAction action)
      • providerPerformPlayDTMFCallAction

        default void providerPerformPlayDTMFCallAction​(@NotNull
                                                       @NotNull CXProvider provider,
                                                       @NotNull
                                                       @NotNull CXPlayDTMFCallAction action)
      • providerPerformSetGroupCallAction

        default void providerPerformSetGroupCallAction​(@NotNull
                                                       @NotNull CXProvider provider,
                                                       @NotNull
                                                       @NotNull CXSetGroupCallAction action)
      • providerPerformSetHeldCallAction

        default void providerPerformSetHeldCallAction​(@NotNull
                                                      @NotNull CXProvider provider,
                                                      @NotNull
                                                      @NotNull CXSetHeldCallAction action)
      • providerPerformSetMutedCallAction

        default void providerPerformSetMutedCallAction​(@NotNull
                                                       @NotNull CXProvider provider,
                                                       @NotNull
                                                       @NotNull CXSetMutedCallAction action)
      • providerPerformStartCallAction

        default void providerPerformStartCallAction​(@NotNull
                                                    @NotNull CXProvider provider,
                                                    @NotNull
                                                    @NotNull CXStartCallAction action)
        If provider:executeTransaction:error: returned NO, each perform*CallAction method is called sequentially for each action in the transaction
      • providerTimedOutPerformingAction

        default void providerTimedOutPerformingAction​(@NotNull
                                                      @NotNull CXProvider provider,
                                                      @NotNull
                                                      @NotNull CXAction action)
        Called when an action was not performed in time and has been inherently failed. Depending on the action, this timeout may also force the call to end. An action that has already timed out should not be fulfilled or failed by the provider delegate
      • providerDidBegin

        default void providerDidBegin​(@NotNull
                                      @NotNull CXProvider provider)
        Called when the provider has been fully created and is ready to send actions and receive updates
      • providerDidReset

        void providerDidReset​(@NotNull
                              @NotNull CXProvider provider)
        Called when the provider has been reset. Delegates must respond to this callback by cleaning up all internal call state (disconnecting communication channels, releasing network resources, etc.). This callback can be treated as a request to end all calls without the need to respond to any actions