V2NIMUploadFileParams.java

浏览该文件的文档.

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

import android.text.TextUtils;

/**
 * 文件上传参数
 */
public class V2NIMUploadFileParams {

    /**
     * 文件地址
     */
    private final String filePath;
    /**
     * 场景名
     * 自定义场景使用之前， 需要先调用V2NIMStorageService.addCustomStorageScene新增自定义场景值
     * 默认使用{@link V2NIMStorageSceneConfig#DEFAULT_PROFILE}对应的场景名
     */
    private final String sceneName;

    public V2NIMUploadFileParams() {
        this.filePath = null;
        this.sceneName = null;
    }

    /**
     * @param filePath 文件地址
     */
    public V2NIMUploadFileParams(String filePath) {
        this.filePath = filePath;
        this.sceneName = null;
    }

    /**
     * @param filePath 文件地址
     * @param sceneName 场景名
     */
    public V2NIMUploadFileParams(String filePath, String sceneName) {
        this.filePath = filePath;
        this.sceneName = sceneName;
    }

    /**
     * 返回文件地址
     * @return 文件地址
     */
    public String getFilePath() {
        return filePath;
    }


    /**
     * 返回场景名
     * @return 场景名
     */
    public String getSceneName() {
        if(TextUtils.isEmpty(sceneName)){
            return V2NIMStorageSceneConfig.DEFAULT_PROFILE.getSceneName();
        }
        return sceneName;
    }

    /**
     * 返回是否有效
     * @return
     */
    public boolean isValid() {
        return filePath != null && !filePath.isEmpty();
    }

}