Agora RTM Objective-C API Reference for iOS/macOS

Inherits from	NSObject
Declared in	AgoraRtmCallKit.h

`rtmKit`

An AgoraRtmKit instance.

@property (atomic, readonly, weak, nullable) AgoraRtmKit *rtmKit

Declared In

AgoraRtmCallKit.h

`callDelegate`

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

@property (nonatomic, weak, nullable) id<AgoraRtmCallDelegate> callDelegate

Declared In

AgoraRtmCallKit.h

`– sendLocalInvitation:completion:`

Allows the caller to send a call invitation to the callee.

- (void)sendLocalInvitation:(AgoraRtmLocalInvitation *_Nonnull)localInvitation completion:(AgoraRtmLocalInvitationSendBlock _Nullable)completion

Parameters

`localInvitation`	An AgoraRtmLocalInvitation object.
`completion`	An AgoraRtmLocalInvitationSendBlock object, which indicates the result of sending a call invitation to a callee. See AgoraRtmInvitationApiCallErrorCode for the error codes. Success: The caller receives the AgoraRtmLocalInvitationSendBlock object with the `AgoraRtmInvitationApiCallErrorOk` state and the localInvitationReceivedByPeer callback. The callee receives the remoteInvitationReceived callback. Failure: The caller receives the AgoraRtmLocalInvitationSendBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

localInvitation

An AgoraRtmLocalInvitation object.

completion

An AgoraRtmLocalInvitationSendBlock object, which indicates the result of sending a call invitation to a callee. See AgoraRtmInvitationApiCallErrorCode for the error codes.

Success:
- The caller receives the AgoraRtmLocalInvitationSendBlock object with the AgoraRtmInvitationApiCallErrorOk state and the localInvitationReceivedByPeer callback.
- The callee receives the remoteInvitationReceived callback.
Failure: The caller receives the AgoraRtmLocalInvitationSendBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h

`– cancelLocalInvitation:completion:`

Allows the caller to cancel a call invitation.

- (void)cancelLocalInvitation:(AgoraRtmLocalInvitation *_Nonnull)localInvitation completion:(AgoraRtmLocalInvitationCancelBlock _Nullable)completion

Parameters

`localInvitation`	An AgoraRtmLocalInvitation object.
`completion`	An AgoraRtmLocalInvitationCancelBlock object. Success: The caller receives the AgoraRtmLocalInvitationCancelBlock object with the `AgoraRtmInvitationApiCallErrorOk` state and the localInvitationCanceled callback. The callee receives the remoteInvitationCanceled callback. Failure: The caller receives the AgoraRtmLocalInvitationCancelBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

localInvitation

An AgoraRtmLocalInvitation object.

completion

An AgoraRtmLocalInvitationCancelBlock object.

Success:
- The caller receives the AgoraRtmLocalInvitationCancelBlock object with the AgoraRtmInvitationApiCallErrorOk state and the localInvitationCanceled callback.
- The callee receives the remoteInvitationCanceled callback.
Failure: The caller receives the AgoraRtmLocalInvitationCancelBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h

`– acceptRemoteInvitation:completion:`

Allows the callee to accept a call invitation.

- (void)acceptRemoteInvitation:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation completion:(AgoraRtmRemoteInvitationAcceptBlock _Nullable)completion

Parameters

`remoteInvitation`	An AgoraRtmRemoteInvitation object.
`completion`	An AgoraRtmRemoteInvitationAcceptBlock object. Success: The caller receives the AgoraRtmRemoteInvitationAcceptBlock object with the `AgoraRtmInvitationApiCallErrorOk` state and the localInvitationAccepted callback. The callee receives the remoteInvitationAccepted callback. Failure: The caller receives the AgoraRtmRemoteInvitationAcceptBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

remoteInvitation

An AgoraRtmRemoteInvitation object.

completion

An AgoraRtmRemoteInvitationAcceptBlock object.

Success:
- The caller receives the AgoraRtmRemoteInvitationAcceptBlock object with the AgoraRtmInvitationApiCallErrorOk state and the localInvitationAccepted callback.
- The callee receives the remoteInvitationAccepted callback.
Failure: The caller receives the AgoraRtmRemoteInvitationAcceptBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h

`– refuseRemoteInvitation:completion:`

Allows the callee to decline a call invitation.

- (void)refuseRemoteInvitation:(AgoraRtmRemoteInvitation *_Nonnull)remoteInvitation completion:(AgoraRtmRemoteInvitationRefuseBlock _Nullable)completion

Parameters

`remoteInvitation`	An AgoraRtmRemoteInvitation object.
`completion`	An AgoraRtmRemoteInvitationRefuseBlock object. Success: The caller receives the AgoraRtmRemoteInvitationRefuseBlock object with the `AgoraRtmInvitationApiCallErrorOk` state and the localInvitationRefused callback. The callee receives the remoteInvitationRefused callback. Failure: The caller receives the AgoraRtmRemoteInvitationRefuseBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

remoteInvitation

An AgoraRtmRemoteInvitation object.

completion

An AgoraRtmRemoteInvitationRefuseBlock object.

Success:
- The caller receives the AgoraRtmRemoteInvitationRefuseBlock object with the AgoraRtmInvitationApiCallErrorOk state and the localInvitationRefused callback.
- The callee receives the remoteInvitationRefused callback.
Failure: The caller receives the AgoraRtmRemoteInvitationRefuseBlock object with an error code. See AgoraRtmInvitationApiCallErrorCode for the error codes.

Declared In

AgoraRtmCallKit.h

AgoraRtmCallKit Class Reference

rtmKit

Declared In

callDelegate

Declared In

– sendLocalInvitation:completion:

Parameters

Declared In

– cancelLocalInvitation:completion:

Parameters

Declared In

– acceptRemoteInvitation:completion:

Parameters

Declared In

– refuseRemoteInvitation:completion:

Parameters

Declared In

`rtmKit`

`callDelegate`

`– sendLocalInvitation:completion:`

`– cancelLocalInvitation:completion:`

`– acceptRemoteInvitation:completion:`

`– refuseRemoteInvitation:completion:`