CPCallApplicationDelegate

Objective-C

@protocol CPCallApplicationDelegate <NSObject>

Swift

protocol CPCallApplicationDelegate : NSObjectProtocol

Represents events of Call This protocol must be conformed by classes which uses CPCallService

Since

1.0.0

  • This method is invoked when there is an IncomingCall Used for informing the application about new call.

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)incomingCall:(nonnull id<CPIncomingCallDelegate>)call;

    Parameters

    call

    reference of incoming call

  • This is the call back method for any call state change on the CallDelegate.

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)callStatusChanged:(nonnull id<CPCallDelegate>)call
                withState:(nonnull CPCallState *)callState;

    Parameters

    call

    which of state changed
    callState

    the new state of the related call

  • This method is invoked when a detailed call information is available that can be used on statistics

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)callAdditionalInfoChanged:(nonnull id<CPCallDelegate>)call
                   withDictionary:(nonnull NSDictionary *)detailedInfo;

    Parameters

    call

    related call
    detailedInfo

    additional info dictionary

  • This is the call back method for any call’s media attributes change on the CallDelegate.

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)mediaAttributesChanged:(nonnull id<CPCallDelegate>)call
           withMediaAttributes:(nonnull CPMediaAttributes *)mediaAttributes;

    Parameters

    call

    which of media attributes changed
    mediaAttributes

    the new media attributes of the related call

  • This method is invoked when establishCall has succeeded.

    See

    [CPOutgoingCallDelegate establishCall:]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)establishCallSucceeded:(nonnull id<CPOutgoingCallDelegate>)call;

    Parameters

    call

    performed establishment successfully

  • This method is invoked when establishCall has failed.

    See

    [CPOutgoingCallDelegate establishCall:]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)establishCallFailed:(nonnull id<CPOutgoingCallDelegate>)call
                  withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t made outgoing call establisment
    error

    definition of failure

  • Method invoked when attempt to accept an incoming call has succeeded.

    See

    [CPIncomingCallDelegate acceptCall:]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)acceptCallSucceed:(nonnull id<CPIncomingCallDelegate>)call;

    Parameters

    call

    performed accepting successfully

  • Method invoked when attempt to accept an incoming call has failed.

    See

    [CPIncomingCallDelegate acceptCall:]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)acceptCallFailed:(nonnull id<CPIncomingCallDelegate>)call
               withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t be accepted
    error

    definition of failure

  • Method invoked when attempt to reject an incoming call has succeeded.

    See

    [CPIncomingCallDelegate rejectCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)rejectCallSuccedded:(nonnull id<CPIncomingCallDelegate>)call;

    Parameters

    call

    performed reject successfully

  • Method invoked when attempt to reject an incoming call has failed.

    See

    [CPIncomingCallDelegate rejectCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)rejectCallFailed:(nonnull id<CPIncomingCallDelegate>)call
               withError:(nonnull CPError *)error;

    Parameters

    call

    that couldn’t be rejected
    error

    definition of failure

  • Method invoked when attempt to ignore a call has succeeded.

    See

    [CPIncomingCallDelegate ignoreCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)ignoreSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed ignore successfully

  • Method invoked when attempt to ignore a call has failed.

    See

    [CPIncomingCallDelegate ignoreCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)ignoreFailed:(nonnull id<CPCallDelegate>)call
           withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t be ignored
    error

    definition of failure

  • Method invoked when attempt to sendRingingFeedback an incoming call has succeeded.

    See

    [IncomingCallDelegate sendRingingFeedback] @since 2.15.0

    Declaration

    Objective-C

    - (void)sendRingingFeedbackSucceed:(nonnull id<CPIncomingCallDelegate>)call;

    Parameters

    call

    performed sendRingingFeedback successfully

  • Method invoked when attempt to sendRingingFeedback an incoming call has failed.

    See

    [IncomingCallDelegate sendRingingFeedback] @since 2.15.0

    Declaration

    Objective-C

    - (void)sendRingingFeedbackFailed:(nonnull id<CPIncomingCallDelegate>)call
                        withError:(nonnull CPError *)error;

    Parameters

    call

    that coludn’t send ringing feedback
    error

    definition of failure

  • This method is invoked when endCall has succeeded. This is the call back method for the endCall request

    See

    [CPCallDelegate endCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)endCallSucceeded:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed end successfully

  • This method is invoked when endCall has failed. This is the call back method for the endCall request

    See

    [CPCallDelegate endCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)endCallFailed:(nonnull id<CPCallDelegate>)call
            withError:(nonnull CPError *)error;

    Parameters

    call

    coudn’t be ended
    error

    definition of failure

  • Method invoked when attempt to mute a call has succeeded.

    See

    [CPCallDelegate mute]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)muteCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed mute successfully

  • Method invoked when attempt to mute a call has failed.

    See

    [CPCallDelegate mute]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)muteCallFailed:(nonnull id<CPCallDelegate>)call
             withError:(nonnull CPError *)error;

    Parameters

    call

    coudn’t be muted
    error

    definition of failure

  • Method invoked when attempt to unmute a call has succeeded.

    See

    [CPCallDelegate unMute]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)unMuteCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed unmute successfully

  • Method invoked when attempt to unmute a call has failed.

    See

    [CPCallDelegate unMute]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)unMuteCallFailed:(nonnull id<CPCallDelegate>)call
               withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t be unmuted
    error

    definition of failure

  • Method invoked when attempt to start video on a call has succeeded.

    See

    [CPCallDelegate videoStart]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)videoStartSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed video start successfully

  • Method invoked when attempt to start video on a call has failed.

    See

    [CPCallDelegate videoStart]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)videoStartFailed:(nonnull id<CPCallDelegate>)call
               withError:(nonnull CPError *)error;

    Parameters

    call

    coudn’t start video
    error

    definition of failure

  • Method invoked when attempt to stop video on a call has succeeded.

    See

    [CPCallDelegate videoStop]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)videoStopSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed stop video successfully

  • Method invoked when attempt to stop video on a call has failed.

    See

    [CPCallDelegate videoStop]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)videoStopFailed:(nonnull id<CPCallDelegate>)call
              withError:(nonnull CPError *)error;

    Parameters

    call

    coudn’t stop video
    error

    definition of failure

  • Method invoked when attempt to hold a call has succeeded.

    See

    [CPCallDelegate holdCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)holdCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed hold successfully

  • Method invoked when attempt to hold a call has failed.

    See

    [CPCallDelegate holdCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)holdCallFailed:(nonnull id<CPCallDelegate>)call
             withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t be holded
    error

    definition of failure

  • Method invoked when attempt to unHold a call has succeded.

    See

    [CPCallDelegate unHoldCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)unHoldCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed unhold successfully

  • Method invoked when attempt to unHold a call has failed.

    See

    [CPCallDelegate unHoldCall]

    Since

    1.0.0

    Declaration

    Objective-C

    - (void)unHoldCallFailed:(nonnull id<CPCallDelegate>)call
               withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t be unholded
    error

    definition of failure

  • Method invoked when attempt to transfer a call has succeeded.

    See

    [CallDelegate transferCall:] @since 1.7.0

    Declaration

    Objective-C

    - (void)transferCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed transfer call successfully

  • Method invoked when attempt to transfer a call has failed.

    See

    [CallDelegate transferCall:] @since 1.7.0

    Declaration

    Objective-C

    - (void)transferCallFailed:(nonnull id<CPCallDelegate>)call
                 withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t made transferring
    error

    reason of the failure

  • Method invoked when attempt to forward a call has succeeded.

    See

    [CallDelegate transferCall:] @since 2.2.0

    Declaration

    Objective-C

    - (void)forwardCallSucceed:(nonnull id<CPCallDelegate>)call;

    Parameters

    call

    performed forward call successfully

  • Method invoked when attempt to forward a call has failed.

    See

    [CallDelegate forwardCall:] @since 2.2.0

    Declaration

    Objective-C

    - (void)forwardCallFailed:(nonnull id<CPCallDelegate>)call
                withError:(nonnull CPError *)error;

    Parameters

    call

    couldn’t succeed forward operation
    error

    reason of the failure