Agora RTC Objective-C API Reference Refactor

Instance Methods
AgoraRtmClientKit Class Reference

Inherits <NSObject>.

## Instance Methods
(instancetype _Nullable) | - initWithConfig:delegate:
(AgoraRtmStreamChannel *_Nullable) | - createStreamChannel:
(int) | - destroy

## Detailed Description

The AgoraRtmClientKit class.

This class provides the main methods that can be invoked by your app.

AgoraRtmClientKit is the basic interface class of the Agora RTM SDK. Creating an AgoraRtmClientKit object and then calling the methods of this object enables you to use Agora RTM SDK's functionality.

## Method Documentation

## ◆ initWithConfig:delegate:

- (instancetype _Nullable) initWithConfig: |  | (AgoraRtmClientConfig *_Nonnull) | config
delegate: |  | (id< AgoraRtmClientDelegate > _Nullable) | delegate

Initializes the rtm client instance.

Parameters

  [in] | config | The configurations for RTM Client.
  [in] | delegate | The callbacks handler.

## ◆ createStreamChannel:

- (AgoraRtmStreamChannel * _Nullable) createStreamChannel: |  | (NSString *_Nonnull) | channelName |

create a stream channel instance.

Parameters

  [in] | channelName | The Name of the channel.

## ◆ destroy

- (int) destroy |  |  |

destroy the rtm client instance.

Returns
  - 0: Success.
  - < 0: Failure.

## Property Documentation

## ◆ agoraRtmDelegate

- (id<AgoraRtmClientDelegate>) agoraRtmDelegate
| readwriteatomicweak