跳到主要内容

消息下载

功能描述

  • SDK 提供多媒体文件的下载、取消、暂停功能。
  • 多媒体消息的发送,请参见消息发送 中的「发送媒体消息」部分。

下载多媒体消息

提示

此接口不支持 Flutter For Web 端

下载多媒体文件。

方法

Future<int> downloadMediaMessage(RCIMIWMediaMessage message, {RCIMIWDownloadMediaMessageListener? listener});

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage需要下载的媒体消息实体
listenerRCIMIWDownloadMediaMessageListener下载媒体消息的事件监听

返回值

返回值描述
Future<int>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

代码示例

RCIMIWDownloadMediaMessageListener? listener = RCIMIWDownloadMediaMessageListener(onMediaMessageDownloading: (RCIMIWMediaMessage? message, int? progress) {
//...
}, onDownloadingMediaMessageCanceled: (RCIMIWMediaMessage? message) {
//...
}, onMediaMessageDownloaded: (int? code, RCIMIWMediaMessage? message) {
//...
});

int? ret = await engine?.downloadMediaMessage(message, listener:listener);

回调方法

  • onMediaMessageDownloading

    接口调用结果的监听

Function(RCIMIWMediaMessage? message, int? progress)? onMediaMessageDownloading;

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage下载的消息
progressint下载的进度

代码示例

engine?.onMediaMessageDownloading = (RCIMIWMediaMessage? message, int? progress) {
//...
};
  • onMediaMessageDownloaded

    接口调用结果的监听

Function(int? code, RCIMIWMediaMessage? message)? onMediaMessageDownloaded;

参数说明

参数名参数类型描述
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMediaMessage下载的消息

代码示例

engine?.onMediaMessageDownloaded = (int? code, RCIMIWMediaMessage? message) {
//...
};

取消多媒体消息

提示

此接口不支持 Flutter For Web 端

取消多媒体消息下载。

方法

Future<int> cancelDownloadingMediaMessage(RCIMIWMediaMessage message, {IRCIMIWCancelDownloadingMediaMessageCallback? callback});

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage需要取消下载的媒体消息实体
callbackIRCIMIWCancelDownloadingMediaMessageCallback取消下载媒体消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Future<int>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

代码示例

返回值描述
Future<int>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

回调方法

  • onDownloadingMediaMessageCanceled

接口调用结果的监听

Function(int? code, RCIMIWMediaMessage? message)? onDownloadingMediaMessageCanceled;

参数说明

参数名参数类型描述
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMediaMessage取消下载的消息

代码示例

engine?.onDownloadingMediaMessageCanceled = (int? code, RCIMIWMediaMessage? message) {
//...
};