V2NIMSettingService.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.setting.enums.V2NIMP2PMessageMuteMode;
import com.netease.nimlib.sdk.v2.setting.enums.V2NIMTeamMessageMuteMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamType;

import java.util.List;
import java.util.Map;

/**
 * V2设置服务
 */
public interface V2NIMSettingService {

    /**
     * 获取会话消息免打扰状态
     * @param conversationId 会话id
     * @return
     */
    boolean getConversationMuteStatus(String conversationId);

    /**
     * 设置群消息免打扰模式
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param muteMode 设置的消息提醒模式
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setTeamMessageMuteMode(String teamId, V2NIMTeamType teamType, V2NIMTeamMessageMuteMode muteMode, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取群消息提醒模式
     * @param teamId 群组id
     * @param teamType 群组类型
     * @return
     */
    V2NIMTeamMessageMuteMode getTeamMessageMuteMode(String teamId, V2NIMTeamType teamType);

    /**
     * 获取我所在的群消息免打扰模式
     * 包括退出的群，解散的群
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getAllTeamMessageMuteMode(V2NIMTeamType teamType,V2NIMSuccessCallback<Map<String, V2NIMTeamMessageMuteMode>> success, V2NIMFailureCallback failure);

    /**
     * 设置P2P消息免打扰模式
     * @param accountId
     * @param muteMode
     * @param success
     * @param failure
     */
    void setP2PMessageMuteMode(String accountId, V2NIMP2PMessageMuteMode muteMode, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取P2P消息免打扰模式
     * @param accountId
     * @return
     */
    V2NIMP2PMessageMuteMode getP2PMessageMuteMode(String accountId);

    /**
     * 获取点对点消息免打扰列表
     * 返回V2NIMP2PMessageMuteMode状态为V2NIM_P2P_MESSAGE_MUTE_MODE_ON的用户
     *
     * @param success 获取列表成功的回调
     * @param failure 获取列表失败的回调*/
    void getP2PMessageMuteList(V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);


    /**
     * 设置当桌面端在线时，移动端是否需要推送
     * 运行在移动端时， 需要调用该接口
     *
     * @param need 免打扰与详情配置参数
     *             桌面端在线时，移动端是否需要推送
     *              true： 需要
     *              fasle：不需要
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setPushMobileOnDesktopOnline(boolean need, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取当桌面端在线时，移动端是否需要推送配置
     * @return 桌面端在线时，移动端是否需要推送,  true： 需要， false：不需要
     */
    boolean getPushMobileOnDesktopOnline();

    /**
     * 设置Apns免打扰与详情显示
     *
     * @param config 免打扰与详情配置参数,小时0～23，分钟0～59
     * @param success 请求成功的回调
     * @param failure 请求失败的回调
     */
    void setDndConfig(V2NIMDndConfig config, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取Apns免打扰与详情显示
     * @return 免打扰与详情配置参数
     */
    V2NIMDndConfig getDndConfig();


    /**
     * 添加设置监听
     * @param listener
     */
    void addSettingListener(V2NIMSettingListener listener);

    /**
     * 移除设置监听
     * @param listener
     */
    void removeSettingListener(V2NIMSettingListener listener);
}