消息 下载
功能描述
- SDK 提供多媒体文件的下载、取消、暂停功能。
- 多媒体消息的发送，请参见消息发送 中的「发送媒体消息」部分。
下载多媒体消息
下载多媒体文件。
方法
Dart
Future<int> downloadMediaMessage(RCIMIWMediaMessage message, {RCIMIWDownloadMediaMessageListener? listener});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| message | RCIMIWMediaMessage | 需要下载的媒体消息实体 |
| listener | RCIMIWDownloadMediaMessageListener | 下载媒体消息的事件监听 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
RCIMIWDownloadMediaMessageListener? listener = RCIMIWDownloadMediaMessageListener(
onMediaMessageDownloading: (RCIMIWMediaMessage? message, int? progress) {
//...
},
onDownloadingMediaMessageCanceled: (RCIMIWMediaMessage? message) {
//...
},
onMediaMessageDownloaded: (int? code, RCIMIWMediaMessage? message) {
//...
});
int? ret = await engine?.downloadMediaMessage(message, listener);
取消多媒体消息下载
取消多媒体消息下载。
方法
Dart
Future<int> cancelDownloadingMediaMessage(RCIMIWMediaMessage message, {IRCIMIWCancelDownloadingMediaMessageCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| message | RCIMIWMediaMessage | 需要取消下载的媒体消息实体 |
| callback | IRCIMIWCancelDownloadingMediaMessageCallback | 取消下载媒体消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
RCIMIWDownloadMediaMessageListener? listener = RCIMIWDownloadMediaMessageListener(
onCancelDownloadingMediaMessageCalled: (int? code, RCIMIWMediaMessage? message) {
//...
});
int? ret = await engine?.cancelDownloadingMediaMessage(message, listener);