V2NIMUtilityService.java

浏览该文件的文档.

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

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.utility.option.V2NIMExportMessageOption;
import com.netease.nimlib.sdk.v2.utility.option.V2NIMImportMessageOption;

public interface V2NIMUtilityService {

    /**
     * 导出本地消息到目标文件
     * <p>
     * 导入/导出过程中调用接口，本次调用抛错，上次调用继续执行
     * </p>
     *
     * @param option   导出消息选项
     *                 <ul>
     *                 <li>导出文件路径</li>
     *                 <li>如果文件存在，报错</li>
     *                 <li>如果不传入文件路径，先判断是否存在sdk创建文件，如果存在先删除，
     *                 本地沙盒创建文件路径+命名【沙盒路径/nim_sdk/historyMessage】</li>
     *                 </ul>
     * @param success  查询成功回调
     * @param failure  查询失败回调
     * @param progress 导出消息进度回调
     */
    void exportMessagesToPath(V2NIMExportMessageOption option,
                              V2NIMSuccessCallback<String> success,
                              V2NIMFailureCallback failure,
                              V2NIMProgressCallback progress);

    /**
     * 从目标文件导入本地消息
     * <p>
     * 导入/导出过程中调用接口，本次调用抛错，上次调用继续执行
     * </p>
     *
     * @param option   导入消息选项
     *                 <ul>
     *                 <li>导入文件路径</li>
     *                 <li>如果文件不存在，报错</li>
     *                 </ul>
     * @param success  查询成功回调
     * @param failure  查询失败回调
     * @param progress 导入消息进度回调
     */
    void importMessagesFromPath(V2NIMImportMessageOption option,
                                V2NIMSuccessCallback<Void> success,
                                V2NIMFailureCallback failure,
                                V2NIMProgressCallback progress);

    /**
     * 取消当前导入/导出消息
     */
    void cancelMigrateMessages();

}