#include <IAgoraRtmService.h>
继承自 agora::rtm::IMessage .
◆ getSize()
| virtual long long agora::rtm::IFileMessage::getSize |
( |
| ) |
const |
|
pure virtual |
获取上传文件的大小。
- 返回
- 上传文件的大小，单位为字节。
◆ getMediaId()
| virtual const char * agora::rtm::IFileMessage::getMediaId |
( |
| ) |
const |
|
pure virtual |
获取上传文件的 media ID。
- 注解
- 文件成功上传到服务器后，SDK 会自动分配一个 media ID。
- media ID 的有效期为 7 天，因为每份上传文件只能在文件服务器保留 7 天。
- 返回
- 上传文件的 media ID。
◆ setThumbnail()
| virtual void agora::rtm::IFileMessage::setThumbnail |
( |
const uint8_t * |
thumbnail, |
|
|
int |
length |
|
) |
| |
|
pure virtual |
指定上传文件的缩略图（二进制文件）。
- 参数
-
| thumbnail | 上传文件的缩略图。必须是二进制文件。 |
| length | 缩略图的数据长度，单位为字节。数据长度 length 和 fileName 加起来的大小不得超过 32 KB。 |
◆ getThumbnailData()
| virtual const char * agora::rtm::IFileMessage::getThumbnailData |
( |
| ) |
const |
|
pure virtual |
◆ getThumbnailLength()
| virtual const long long agora::rtm::IFileMessage::getThumbnailLength |
( |
| ) |
const |
|
pure virtual |
获取缩略图的数据长度。
- 返回
- 缩略图的数据长度，单位为字节。
◆ setFileName()
| virtual void agora::rtm::IFileMessage::setFileName |
( |
const char * |
fileName | ) |
|
|
pure virtual |
设置上传文件的文件名。
- 参数
-
| fileName | 上传文件的文件名。thumbnail 和 fileName 加起来的大小不得超过 32 KB。 |
◆ getFileName()
| virtual const char * agora::rtm::IFileMessage::getFileName |
( |
| ) |
const |
|
pure virtual |
◆ getMessageId()
| virtual long long agora::rtm::IMessage::getMessageId |
( |
| ) |
const |
|
pure virtualinherited |
获取消息 ID。
- 返回
- 消息的唯一 ID，在消息对象创建时自动生成。
◆ getMessageType()
| virtual MESSAGE_TYPE agora::rtm::IMessage::getMessageType |
( |
| ) |
const |
|
pure virtualinherited |
◆ setText()
| virtual void agora::rtm::IMessage::setText |
( |
const char * |
str | ) |
|
|
pure virtualinherited |
设置文本消息正文或自定义二进制消息的文字描述。
- 注解
- 最大长度为 32 KB。如果消息为自定义二进制消息，请确保文字描述和二进制消息的总大小不超过 32 KB。
- 参数
-
◆ getText()
| virtual const char * agora::rtm::IMessage::getText |
( |
| ) |
const |
|
pure virtualinherited |
获取文本消息正文或自定义二进制消息的文字描述。
- 返回
- 文本消息正文或自定义二进制消息的文字描述。
◆ getRawMessageData()
| virtual const char * agora::rtm::IMessage::getRawMessageData |
( |
| ) |
const |
|
pure virtualinherited |
获取自定义消息在内存中的首地址。
- 返回
- 自定义消息在内存中的首地址。
◆ getRawMessageLength()
| virtual int agora::rtm::IMessage::getRawMessageLength |
( |
| ) |
const |
|
pure virtualinherited |
获取自定义消息的长度。
- 返回
- 自定义消息的长度（字节）。
◆ getServerReceivedTs()
| virtual long long agora::rtm::IMessage::getServerReceivedTs |
( |
| ) |
const |
|
pure virtualinherited |
供消息接收者获取消息服务器接收到消息的时间戳。
- 注解
- 你不能设置时间戳，但是你可以从该时间戳推断出消息的大致发送时间。
- 时间戳仅用于展示，不建议用于消息的严格排序。
- 返回
- 消息服务器接收到消息的时间戳（毫秒）。
◆ isOfflineMessage()
| virtual bool agora::rtm::IMessage::isOfflineMessage |
( |
| ) |
const |
|
pure virtualinherited |
供消息接收者检查消息是否在服务端被保存过（仅适用于点对点消息）。
- 注解
- 如果消息没有被消息服务器保存过，该方法将返回 false。也就是说：只有当消息发送者通过设置 enableOfflineMessaging=true 发送离线消息且在发送离线消息时对端不在线，对端重新上线后调用该方法会返回 true。
- 目前我们只为每个接收端保存 200 条离线消息最长七天。当保存的离线消息超出限制时，最老的信息将会被最新的消息替换。
- 返回
- true: 被保存过（消息服务器保存了该条消息且在对端重新上线后重新发送成功）。
- false: 未被保存过。
◆ release()
| virtual void agora::rtm::IMessage::release |
( |
| ) |
|
|
pure virtualinherited |
