MiscService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.misc;

import com.netease.nimlib.sdk.InvocationFuture;

import java.util.List;

/**
 * 其他接口类，提供日志文件上传、SDK 本地缓存、获取云信服务端时间等接口。
 */
public interface MiscService {

    /**
     * 将多个日志文件打包成一个 zip 压缩文件并返回其路径。
     * @return zip 压缩包所在的完整路径。
     */
    InvocationFuture<String> zipLogs();

    /**
     * 获取指定时间范围内指定类型的文件在 SDK 缓存中的大小。
     * @param fileTypes 文件类型列表
     * @param startTime 开始时间，单位毫秒，设置为 0 表示不限制起始时间。
     * @param endTime 结束时间，单位毫秒，设置为 0 表示不限制结束时间。
     * @return 缓存大小
     */
    InvocationFuture<Long> getSizeOfDirCache(List<DirCacheFileType> fileTypes, long startTime, long endTime);

    /**
     * 删除指定时间范围内指定类型的文件的 SDK 缓存。
     * @param fileTypes 文件类型列表
     * @param startTime 开始时间，单位毫秒，设置为 0 表示不限制起始时间。
     * @param endTime 结束时间，单位毫秒，设置为 0 表示不限制结束时间。
     * @return 无返回值
     */
    InvocationFuture<Void> clearDirCache(List<DirCacheFileType> fileTypes, long startTime, long endTime);

    /**
     * 获取服务器当前的时间戳。
     * 频控限制详见 {@link com.netease.nimlib.sdk.SDKOptions#fetchServerTimeInterval}
     * @return  如果调用处于频控限制内，返回的时间为上一次获取时间+两次时间的偏移量。
     */
    InvocationFuture<Long> getServerTime();

    /**
     * 主动上传 SDK 日志。
     * @param cut true：上传部分日志；false：上传全部日志
     * @param roomId 聊天室 ID，可设置为空。
     * @param uploadMsg 上传附言，长度上限为 4096 个字符，可设置为空。
     *
     * @return {@link InvocationFuture} 日志上传结果
     */
    InvocationFuture<String> getSdkLogUpload(boolean cut, String roomId, String uploadMsg);

}