NosService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.nos;

import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.NosTokenSceneConfig;
import com.netease.nimlib.sdk.nos.model.NosThumbParam;

import java.io.File;

/**
 * 网易云存储服务
 */

@NIMService("网易云存储服务")
public interface NosService {

    /**
     * 使用默认的nos scene {@link NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE}上传文件
     * 参考 {@link #uploadAtScene(File, String, String)}
     *
     * @param file     file
     * @param mimeType file type
     * @return AbortableFuture
     */
    AbortableFuture<String> upload(File file, String mimeType);

    /**
     * 与{@link #upload(File, String)}功能一样，不过指定了上传文件时用的nos scene
     *
     * @param file     file
     * @param mimeType file type
     * @param sceneKey 上传文件时用的nos sceneKey ，默认值：{@link NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE} ， nos token scene 配置参考{@link NosTokenSceneConfig}
     * @return AbortableFuture
     */
    AbortableFuture<String> uploadAtScene(File file, String mimeType, String sceneKey);

    /**
     * 与{@link #upload(File, String)}功能一样，不过指定了上传文件时用的nos scene 以及是否需要强制重新上传文件
     *
     * @param file                  file
     * @param mimeType              file type
     * @param sceneKey              上传文件时用的nos sceneKey ，默认值：{@link NimNosSceneKeyConstant#NIM_DEFAULT_PROFILE} ， nos token scene 配置参考{@link NosTokenSceneConfig}
     * @param enableForceUploadFile 如果服务器存在相同的文件，是否强制重新上传文件 ，默认false
     * @return AbortableFuture
     */
    AbortableFuture<String> uploadEnableForce(File file, String mimeType, String sceneKey, boolean enableForceUploadFile);


    /**
     * 下载文件
     *
     * @param url   文件url
     * @param thumb 缩略图配置
     * @param path  下载保存路径
     * @return AbortableFuture
     */
    AbortableFuture<Void> download(String url, NosThumbParam thumb, String path);


    /**
     * 通过安全链接下载文件
     *
     * @param url   文件url
     * @param path  下载保存路径
     * @return AbortableFuture
     */
    AbortableFuture<Void> downloadFileSecure(String url, String path);


    /**
     * 将文件url 转换成CDN 加速url ，如果不支持，返回原链接
     *
     * @param url 原始链接
     * @return CDN 加速链接，如果不支持，返回原链接
     */
    String convertDownloadUrlToCDNUrl(String url);


    /**
     * 针对开启了NOS 文件安全功能的用户，可能通过短链获取原始链接，注意保护原始链接不要外泄
     *
     * @param shortUrl 短链 ，如果参数不是长链，返回414
     * @return InvocationFuture
     */
    InvocationFuture<String> getOriginUrlFromShortUrl(String shortUrl);


    /**
     * 针对开启了NOS 文件安全功能的用户，可能通过短链获取原始链接，注意保护原始链接不要外泄
     *
     * @param roomId 聊天室id
     * @param shortUrl 短链 ，如果参数不是长链，返回414
     * @return InvocationFuture
     */
    InvocationFuture<String> getOriginUrlFromShortUrl(String roomId, String shortUrl);

}