Agora RTC Objective-C API Reference  Refactor
Instance Methods
<AgoraRtmClientDelegate> Protocol Reference

Inherits <NSObject>.

Instance Methods

(void) - rtmKit:didReceiveLinkStateEvent:
 
(void) - rtmKit:didReceiveMessageEvent:
 
(void) - rtmKit:didReceivePresenceEvent:
 
(void) - rtmKit:didReceiveLockEvent:
 
(void) - rtmKit:didReceiveStorageEvent:
 
(void) - rtmKit:didReceiveTopicEvent:
 
(void) - rtmKit:tokenPrivilegeWillExpire:
 
(void) - rtmKit:channel:connectionChangedToState:reason:
 

Method Documentation

◆ rtmKit:didReceiveLinkStateEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceiveLinkStateEvent: (AgoraRtmLinkStateEvent *_Nonnull)  event 
optional

Occurs when link state change

Parameters
rtmKitthe AgoraRtmClientKit Object.
eventdetails of link state event.

◆ rtmKit:didReceiveMessageEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceiveMessageEvent: (AgoraRtmMessageEvent *_Nonnull)  event 
optional

Occurs when receive a message.

Parameters
rtmKitthe AgoraRtmClientKit Object.
eventdetails of message event.

◆ rtmKit:didReceivePresenceEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceivePresenceEvent: (AgoraRtmPresenceEvent *_Nonnull)  event 
optional

Occurs when remote user presence changed

Parameters
rtmKitthe AgoraRtmClientKit Object.
eventdetails of presence event.

◆ rtmKit:didReceiveLockEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceiveLockEvent: (AgoraRtmLockEvent *_Nonnull)  event 
optional

Occurs when lock state changed

Parameters
rtmKitthe AgoraRtmClientKit Object.
eventdetails of lock event.

◆ rtmKit:didReceiveStorageEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceiveStorageEvent: (AgoraRtmStorageEvent *_Nonnull)  event 
optional

Occurs when receive storage event

Parameters
rtmKitthe AgoraRtmClientKit Object
eventdetails of storage event.

◆ rtmKit:didReceiveTopicEvent:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
didReceiveTopicEvent: (AgoraRtmTopicEvent *_Nonnull)  event 
optional

Occurs when remote user join/leave topic or when user first join this channel, got snapshot of topics in this channel

Parameters
rtmKitthe AgoraRtmClientKit Object.
eventdetails of topic event.

◆ rtmKit:tokenPrivilegeWillExpire:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  rtmKit
tokenPrivilegeWillExpire: (NSString *_Nullable)  channel 
optional

Occurs when token will expire in 30 seconds.

Parameters
rtmKitthe AgoraRtmClientKit Object.
channelNameThe name of the channel.

◆ rtmKit:channel:connectionChangedToState:reason:

- (void) rtmKit: (AgoraRtmClientKit *_Nonnull)  kit
channel: (NSString *_Nonnull)  channelName
connectionChangedToState: (AgoraRtmClientConnectionState state
reason: (AgoraRtmClientConnectionChangeReason reason 
optional

Occurs when the connection state changes between rtm sdk and agora service.

Parameters
rtmKitthe AgoraRtmClientKit Object.
channelNameThe Name of the channel.
stateThe new connection state.
reasonThe reason for the connection state change.