AgoraRtmMessage Class Reference

Inherits from NSObject
Declared in AgoraRtmKit.h

Overview

提供频道消息或点对点文本消息相关属性的数据结构。

  type

消息类别。详见 AgoraRtmMessageType。

@property (nonatomic, assign, readonly) AgoraRtmMessageType type

Discussion

当前仅支持文本消息。

Declared In

AgoraRtmKit.h

  text

文本消息内容。最大长度不得超过 32 KB。

@property (nonatomic, copy) NSString *text

Declared In

AgoraRtmKit.h

  serverReceivedTs

消息服务器接收到消息的时间戳(毫秒)。

@property (nonatomic, assign, readonly) long long serverReceivedTs

Discussion

NOTE

  • 你不能设置时间戳,但是你可以从该时间戳推断出消息的大致发送时间。

  • 时间戳的精度为秒级。仅用于展示,不建议用于消息的严格排序。

Declared In

AgoraRtmKit.h

  isOfflineMessage

(仅适用于点对点消息)供消息接收者检查消息是否在服务端被保存过。

@property (nonatomic, assign, readonly) BOOL isOfflineMessage

Discussion

  • YES: 被保存过(消息服务器保存了该条消息且在对端重新上线后重新发送成功)。

  • NO: 未被保存过。

NOTE

  • 如果消息没有被消息服务器保存过,该方法将返回 NO。也就是说:只有当消息发送者通过设置 enableOfflineMessaging=YES 发送离线消息且在发送离线消息时对端不在线,对端重新上线后调用该方法会返回 YES。
  • 目前我们只为每个接收端保存 200 条离线消息最长七天。当保存的离线消息超出限制时,最老的信息将会被最新的消息替换。

  • Declared In

    AgoraRtmKit.h

    – initWithText:

    创建一个 AgoraRtmMessage 文本消息实例。

    - (instancetype _Nonnull)initWithText:(NSString *)text

    Parameters

    text

    文本消息内容,必须为小于 32 KB 的字符串。

    Return Value

    一个 AgoraRtmMessage 文本消息实例。

    Declared In

    AgoraRtmKit.h