通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM C++ API Reference for Linux & Windows

概览 IRtmService IMessage SendMessageOptions PEER_SUBSCRIPTION_OPTION PeerOnlineStatus RtmAttribute IRtmChannelAttribute ChannelAttributeOptions AgoraRtmChannelMemberCount IChannel IChannelMember IRtmCallManager ILocalCallInvitation IRemoteCallInvitation IRtmServiceEventHandler IChannelEventHandler IRtmCallEventHandler 状态码和错误码

#include <IAgoraRtmService.h>

继承自 agora::rtm::IMessage .

Public 成员函数

virtual long long getSize () const =0
 
virtual const char * getMediaId () const =0
 
virtual void setThumbnail (const uint8_t *thumbnail, long long length)=0
 
virtual const char * getThumbnailData () const =0
 
virtual const long long getThumbnailLength () const =0
 
virtual void setFileName (const char *fileName)=0
 
virtual const char * getFileName () const =0
 
virtual void setWidth (int width)=0
 
virtual int getWidth () const =0
 
virtual void setHeight (int height)=0
 
virtual int getHeight () const =0
 
virtual void setThumbnailWidth (int width)=0
 
virtual int getThumbnailWidth () const =0
 
virtual void setThumbnailHeight (int height)=0
 
virtual int getThumbnailHeight () const =0
 
virtual long long getMessageId () const =0
 
virtual MESSAGE_TYPE getMessageType () const =0
 
virtual void setText (const char *str)=0
 
virtual const char * getText () const =0
 
virtual const char * getRawMessageData () const =0
 
virtual int getRawMessageLength () const =0
 
virtual long long getServerReceivedTs () const =0
 
virtual bool isOfflineMessage () const =0
 
virtual void release ()=0
 

成员函数说明

◆ getSize()

virtual long long agora::rtm::IImageMessage::getSize ( ) const
pure virtual

获取上传图片的大小。

返回
上传图片的大小，单位为字节。

◆ getMediaId()

virtual const char * agora::rtm::IImageMessage::getMediaId ( ) const
pure virtual

获取上传图片的 media ID。

注解
  • 图片成功上传到服务器后，SDK 会自动分配一个 media ID。
  • media ID 的有效期为 7 天，因为每份上传图片只能在文件服务器保留 7 天。
返回
上传图片的 media ID。

◆ setThumbnail()

virtual void agora::rtm::IImageMessage::setThumbnail ( const uint8_t *  thumbnail,
long long  length 
)
pure virtual

指定上传图片的缩略图。

参数
thumbnail上传图片的缩略图。
length缩略图的数据长度，单位为字节。

◆ getThumbnailData()

virtual const char * agora::rtm::IImageMessage::getThumbnailData ( ) const
pure virtual

获取上传图片的缩略图。

返回
上传图片的缩略图。

◆ getThumbnailLength()

virtual const long long agora::rtm::IImageMessage::getThumbnailLength ( ) const
pure virtual

获取缩略图的数据长度。

返回
缩略图的数据长度。

◆ setFileName()

virtual void agora::rtm::IImageMessage::setFileName ( const char *  fileName)
pure virtual

设置上传图片的文件名称。

参数
fileName上传图片的文件名称。

◆ getFileName()

virtual const char * agora::rtm::IImageMessage::getFileName ( ) const
pure virtual

获取上传图片的文件名称。

返回
上传图片的文件名称。

◆ setWidth()

virtual void agora::rtm::IImageMessage::setWidth ( int  width)
pure virtual

设置上传图片的宽度。

注解
  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。你可以通过调用 getWidth 方法直接获取图片的宽度。
  • 用户自行设置的图片宽度会覆盖由 SDK 计算得出的图片宽度。
参数
width上传图片的宽度。

◆ getWidth()

virtual int agora::rtm::IImageMessage::getWidth ( ) const
pure virtual

获取上传图片的宽度。

注解
  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。你可以通过调用本方法直接获取图片的宽度。
  • 用户通过调用 setWidth 方法自行设置的图片宽度会覆盖由 SDK 计算得出的图片宽度。
返回
上传图片的宽度。

◆ setHeight()

virtual void agora::rtm::IImageMessage::setHeight ( int  height)
pure virtual

设置上传图片的高度。

注解
  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。你可以通过调用 getHeight 方法直接获取图片的高度。
  • 用户自行设置的图片高度会覆盖由 SDK 计算得出的图片高度。
参数
height上传图片的高度。

◆ getHeight()

virtual int agora::rtm::IImageMessage::getHeight ( ) const
pure virtual

获取上传图片的高度。

注解
  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。你可以通过调用本方法直接获取图片的高度。
  • 用户通过调用 setHeight 方法自行设置的图片高度会覆盖由 SDK 计算得出的图片高度。
返回
上传图片的高度。

◆ setThumbnailWidth()

virtual void agora::rtm::IImageMessage::setThumbnailWidth ( int  width)
pure virtual

设置缩略图的宽度。

注解
须自行计算，SDK 不会计算缩略图的宽度。
参数
width缩略图的宽度。

◆ getThumbnailWidth()

virtual int agora::rtm::IImageMessage::getThumbnailWidth ( ) const
pure virtual

获取缩略图的宽度。

返回
缩略图的宽度。

◆ setThumbnailHeight()

virtual void agora::rtm::IImageMessage::setThumbnailHeight ( int  height)
pure virtual

设置缩略图的高度。

注解
须自行计算，SDK 不会计算缩略图的高度。
参数
height缩略图的高度。

◆ getThumbnailHeight()

virtual int agora::rtm::IImageMessage::getThumbnailHeight ( ) 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

获取消息类型。

返回
消息类型。详见 MESSAGE_TYPE 。

◆ setText()

virtual void agora::rtm::IMessage::setText ( const char *  str)
pure virtualinherited

设置文本消息正文或自定义二进制消息的文字描述。

注解
最大长度为 32 KB。如果消息为自定义二进制消息，请确保文字描述和二进制消息的总大小不超过 32 KB。
参数
str待设置的消息正文。

◆ 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

释放 IMessage 实例使用的所有资源。

注解
对于消息接收者：请在收到 onMessageReceived 或 onMessageReceivedFromPeer 回调时尽快保存收到的 IMessage 实例内容，因为 SDK 会在回调结束时彻底释放 IMessage 实例造成 IMessage 无法再次获取。