QChatPushService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.mixpush;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.notifier.support26.annotation.NonNull;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.qchat.enums.QChatPushMsgType;
import com.netease.nimlib.sdk.qchat.model.QChatPushConfig;
import com.netease.nimlib.sdk.qchat.param.QChatPushConfigParam;
import com.netease.nimlib.sdk.settings.model.NoDisturbConfig;

/**
 * 第三方推送服务
 * 目前接入的第三方推送有：小米、华为、魅族、fcm。
 */
@NIMService("圈组推送服务")
public interface QChatPushService {
    /**
     * 开启/关闭圈组第三方推送服务
     *
     * @param enable true 开启，SDK 需要与云信服务器做确认；false 关闭，SDK 也需要通知云信服务器。
     * @return InvocationFuture 可以设置回调函数。只有与服务器交互完成后才算成功，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> enable(boolean enable);

    /**
     * 是否开启了圈组第三方推送服务
     *
     * @return 默认开启
     */
    boolean isEnable();

    /**
     * 设置圈组推送免打扰时间，时间参数为北京时间的24小时计数 HH:mm，该时间段将不再向用户推送消息
     *
     * @param isOpen    是否开启
     * @param startTime 开始时间 格式 HH:mm
     * @param stopTime  结束时间 格式 HH:mm
     * @return InvocationFuture 可以设置回调函数。成功会返回成功信息，错误会返回相应的错误码。
     */
    InvocationFuture<Void> setPushNoDisturbConfig(boolean isOpen, String startTime, String stopTime);

    /**
     * 设置圈组推送是否不展示详情
     *
     * @param showNoDetail 是否不展示详情
     * @return InvocationFuture 可以设置回调函数。成功会返回成功信息，错误会返回相应的错误码。
     */
    InvocationFuture<Void> setPushShowNoDetail(boolean showNoDetail);

    /**
     * 设置圈组推送消息类型
     * @param pushMsgType 推送消息类型
     * @return
     */
    InvocationFuture<Void> setPushMsgType(@NonNull QChatPushMsgType pushMsgType);

    /**
     * 设置圈组推送配置
     * @param param
     * @return
     */
    InvocationFuture<Void> setPushConfig(@NonNull QChatPushConfigParam param);

    /**
     * 获取圈组推送是否不展示详情
     *
     * @return 当前是否不展示详情
     */
    boolean isPushShowNoDetail();

    /**
     * 获取推送免打扰设置
     *
     * @return NoDisturbConfig
     */
    NoDisturbConfig getPushNoDisturbConfig();

    /**
     * 获取推送消息类型
     * @return
     */
    QChatPushMsgType getPushMsgType();

    /**
     * 获取圈组推送设置
     *
     * @return QChatPushConfig
     */
    QChatPushConfig getPushConfig();

    /**
     * 圈组是否存在推送配置。
     *
     * @return SDK 是否存在推送消息提醒的免打扰。
     */
    boolean isPushConfigExist();
}