跳到主要内容

消息下载

功能描述​

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

下载多媒体消息​

下载多媒体文件。

方法​

TypeScript
downloadMediaMessage(
  message: RCIMIWMediaMessage,
  listener: RCIMIWDownloadMediaMessageListener
): Promise<number>;

参数说明​

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

返回值​

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

代码示例​

TypeScript
let listener = {
onMediaMessageDownloading:(res) => {
//...
},
onDownloadingMediaMessageCanceled:(res) => {
//...
},
onMediaMessageDownloaded:(res) => {
//...
}};
let code = await engine.downloadMediaMessage(message, listener);

取消多媒体消息​

取消多媒体消息下载。

方法​

TypeScript
cancelDownloadingMediaMessage(
  message: RCIMIWMediaMessage,
  callback: IRCIMIWCancelDownloadingMediaMessageCallback
): Promise<number>;

参数说明​

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

返回值​

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

代码示例​

TypeScript
let callback = {
onCancelDownloadingMediaMessageCalled:(res) => {
//...
}};

let code = await engine.cancelDownloadingMediaMessage(message, callback);