V2NIMStorageService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.storage;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMProgressCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageAttachment;
import com.netease.nimlib.sdk.v2.storage.model.V2NIMSize;
import com.netease.nimlib.sdk.v2.storage.params.V2NIMDownloadMessageAttachmentParams;
import com.netease.nimlib.sdk.v2.storage.result.V2NIMGetMediaResourceInfoResult;

import java.util.List;

public interface V2NIMStorageService {
    /**
     * 添加自定义存储场景
     *
     * @param sceneName 自定义存储场景
     * @param expireTime 过期时间， 单位秒
     *      0表示永远不过期
     *      否则以该时间为过期时间
     */
    V2NIMStorageScene addCustomStorageScene(String sceneName, long expireTime);

    /**
     * 创建文件上传任务
     * @param fileParams 文件上传的相关参数
     * @return 文件上传任务
     */
    V2NIMUploadFileTask createUploadFileTask(V2NIMUploadFileParams fileParams);

    /**
     * 文件上传
     * @param fileTask 文件上传任务
     * @param success 上传成功回调
     * @param failure 上传失败回调
     * @param progress 上传进度回调
     */
    void uploadFile(V2NIMUploadFileTask fileTask, V2NIMSuccessCallback<String> success,
        V2NIMFailureCallback failure,
        V2NIMProgressCallback progress);

    /**
     * 取消文件上传
     * @param fileTask 文件上传任务
     * @param success 成功回调
     * @param failure 失败回调
     */
    void cancelUploadFile(V2NIMUploadFileTask fileTask, V2NIMSuccessCallback<Void> success,
        V2NIMFailureCallback failure);

    /**
     * 查询存储场景列表
     * @return
     */
    List<V2NIMStorageScene> getStorageSceneList();

    /**
     * 短连接转长连接
     * @param url 短连接url
     * @param success 成功回调
     * @param failure 失败回调
     */
    void shortUrlToLong(String url, V2NIMSuccessCallback<String> success,
        V2NIMFailureCallback failure);

    /**
     * 下载文件
     * @param url 文件url
     * @param filePath 文件保存路径
     * @param success 成功回调
     * @param failure 失败回调
     * @param progress 下载进度回调
     */
    void downloadFile(String url, String filePath, V2NIMSuccessCallback<String> success,
        V2NIMFailureCallback failure, V2NIMProgressCallback progress);

    /**
     * 下载消息附件
     *
     * @param downloadParam 下载参数
     * @param success       下载消息附件成功回调
     * @param failure       下载消息附件失败回调
     * @param progress      下载消息附件进度回调
     */
    void downloadAttachment(V2NIMDownloadMessageAttachmentParams downloadParam, V2NIMSuccessCallback<String> success,
        V2NIMFailureCallback failure, V2NIMProgressCallback progress);

    /**
     * 获取图片消息中的图片缩略图
     * 传入短链自动获取长链地址并携带缩略图相关 URL 查询参数
     * 旧的下载地址会做新的 CDN 加速域名地址替换
     * 开启自定义鉴权会返回对应的鉴权信息
     *
     * @param attachment 消息附件
     * @param thumbSize  缩略图尺寸
     * @param success    成功回调
     * @param failure    失败回调
     * @see V2NIMGetMediaResourceInfoResult
     */
    void getImageThumbUrl(V2NIMMessageAttachment attachment, V2NIMSize thumbSize, V2NIMSuccessCallback<V2NIMGetMediaResourceInfoResult> success,
                          V2NIMFailureCallback failure);

    /**
     * 获取视频消息中的视频封面
     * 传入短链自动获取长链地址并携带视频封面相关 URL 查询参数
     * 旧的下载地址会做新的 CDN 加速域名地址替换
     * 开启自定义鉴权会返回对应的鉴权信息
     *
     * @param attachment 消息附件
     * @param thumbSize  缩略图尺寸
     * @param success    成功回调
     * @param failure    失败回调
     * @see V2NIMGetMediaResourceInfoResult
     */
    void getVideoCoverUrl(V2NIMMessageAttachment attachment, V2NIMSize thumbSize, V2NIMSuccessCallback<V2NIMGetMediaResourceInfoResult> success,
                          V2NIMFailureCallback failure);
}