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

Agora RTM Java API Reference for Android

概览 RtmClient RtmMessage RtmImageMessage RtmFileMessage SendMessageOptions PeerSubscriptionOption PeerOnlineState RtmAttribute RtmChannelAttribute ChannelAttributeOptions RtmChannelMemberCount RtmChannel RtmChannelMember RtmCallManager LocalInvitation RemoteInvitation ResultCallback RtmClientListener RtmChannelListener RtmCallEventListener RtmRequestId RtmMediaOperationProgress 状态码和错误码

继承自 io.agora.rtm.RtmMessage .

Public 成员函数

abstract long getSize ()
 
abstract String getMediaId ()
 
abstract void setThumbnail (byte[] thumbnail)
 
abstract byte[] getThumbnail ()
 
abstract void setFileName (String fileName)
 
abstract String getFileName ()
 
- Public 成员函数 继承自 io.agora.rtm.RtmMessage
abstract void setText (String text)
 
abstract String getText ()
 
abstract void setRawMessage (byte[] data)
 
abstract void setRawMessage (byte[] data, String description)
 
abstract byte[] getRawMessage ()
 
abstract int getMessageType ()
 
abstract long getServerReceivedTs ()
 
abstract boolean isOfflineMessage ()
 

详细描述

用于设置或获取文件消息属性的类。可用于点对点或频道消息。

成员函数说明

◆ getSize()

abstract long io.agora.rtm.RtmFileMessage.getSize ( )
abstract

获取上传文件的大小。

返回
上传文件的大小，单位为字节。

◆ getMediaId()

abstract String io.agora.rtm.RtmFileMessage.getMediaId ( )
abstract

获取上传文件的 media ID。

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

◆ setThumbnail()

abstract void io.agora.rtm.RtmFileMessage.setThumbnail ( byte[]  thumbnail)
abstract

指定上传文件的缩略图（二进制文件）。

参数
thumbnail上传文件的缩略图。必须是二进制文件。

◆ getThumbnail()

abstract byte[] io.agora.rtm.RtmFileMessage.getThumbnail ( )
abstract

获取上传文件的缩略图。

返回
上传文件的缩略图

◆ setFileName()

abstract void io.agora.rtm.RtmFileMessage.setFileName ( String  fileName)
abstract

设置上传文件的文件名。

参数
fileName上传文件的文件名。thumbnail 和 fileName 加起来的大小不得超过 32 KB。

◆ getFileName()

abstract String io.agora.rtm.RtmFileMessage.getFileName ( )
abstract

获取上传文件的文件名。

返回
上传文件的文件名。