AgoraRtmCallDelegate Protocol Reference

Conforms to NSObject
Declared in AgoraRtmCallKit.h

Overview

The AgoraRtmCallDelegate protocol enables Agora RTM call callback event notifications to your app.

– rtmCallKit:localInvitationReceivedByPeer:

Callback to the caller: occurs when the callee receives the call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit localInvitationReceivedByPeer:(AgoraRtmLocalInvitation *_Nonnull)localInvitation

Parameters

callKit

An RtmCallKit object.
localInvitation

An AgoraRtmLocalInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:localInvitationAccepted:withResponse:

Callback to the caller: occurs when the callee accepts the call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit localInvitationAccepted:(AgoraRtmLocalInvitation *_Nonnull)localInvitation withResponse:(NSString *_Nullable)response

Parameters

callKit

An RtmCallKit object.
localInvitation

An AgoraRtmLocalInvitation object.
response

The response set by the callee.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:localInvitationRefused:withResponse:

Callback to the caller: occurs when the callee declines the call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit localInvitationRefused:(AgoraRtmLocalInvitation *_Nonnull)localInvitation withResponse:(NSString *_Nullable)response

Parameters

callKit

An RtmCallKit object.
localInvitation

An AgoraRtmLocalInvitation object.
response

The response set by the callee.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:localInvitationCanceled:

Callback to the caller: occurs when the caller cancels a call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit localInvitationCanceled:(AgoraRtmLocalInvitation *_Nonnull)localInvitation

Parameters

callKit

An RtmCallKit object.
localInvitation

An AgoraRtmLocalInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:localInvitationFailure:errorCode:

Callback to the caller: occurs when the life cycle of the outgoing call invitation ends in failure.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit localInvitationFailure:(AgoraRtmLocalInvitation *_Nonnull)localInvitation errorCode:(AgoraRtmLocalInvitationErrorCode)errorCode

Parameters

callKit

An RtmCallKit object.
localInvitation

An AgoraRtmLocalInvitation object.
errorCode

See AgoraRtmLocalInvitationErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:remoteInvitationReceived:

Callback to the callee: occurs when the callee receives a call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit remoteInvitationReceived:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation

Parameters

callKit

An RtmCallKit object.
remoteInvitation

An AgoraRtmRemoteInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:remoteInvitationRefused:

Callback to the callee: occurs when the callee declines a call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit remoteInvitationRefused:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation

Parameters

callKit

An RtmCallKit object.
remoteInvitation

An AgoraRtmRemoteInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:remoteInvitationAccepted:

Callback to the callee: occurs when the callee accepts a call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit remoteInvitationAccepted:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation

Parameters

callKit

An RtmCallKit object.
remoteInvitation

An AgoraRtmRemoteInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:remoteInvitationCanceled:

Callback to the callee: occurs when the caller cancels the call invitation.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit remoteInvitationCanceled:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation

Parameters

callKit

An RtmCallKit object.
remoteInvitation

An AgoraRtmRemoteInvitation object.

Declared In

AgoraRtmCallKit.h

– rtmCallKit:remoteInvitationFailure:errorCode:

Callback to the callee: occurs when the life cycle of the incoming call invitation ends in failure.

- (void)rtmCallKit:(AgoraRtmCallKit *_Nonnull)callKit remoteInvitationFailure:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation errorCode:(AgoraRtmRemoteInvitationErrorCode)errorCode

Parameters

callKit

An RtmCallKit object.
remoteInvitation

An AgoraRtmRemoteInvitation object.
errorCode

See AgoraRtmRemoteInvitationErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h