eleme.openapi.sdk.api.service.MessageService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eleme-openapi-sdk Show documentation
There is a newer version: 1.30.71
package eleme.openapi.sdk.api.service;

import eleme.openapi.sdk.api.annotation.Service;
import eleme.openapi.sdk.api.base.BaseNopService;
import eleme.openapi.sdk.api.exception.ServiceException;
import eleme.openapi.sdk.oauth.response.Token;
import eleme.openapi.sdk.config.Config;
import eleme.openapi.sdk.api.entity.message.*;
import eleme.openapi.sdk.api.enumeration.message.*;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.*;

/**
 * 消息服务
 */
@Service("eleme.message")
public class MessageService extends BaseNopService {
    public MessageService(Config config,Token token) {
        super(config, token, MessageService.class);
    }

    /**
     * 获取未到达的推送消息
     *
     * @param appId 应用ID
     * @return 消息列表
     * @throws ServiceException 服务异常
     */
    public List getNonReachedMessages(int appId) throws ServiceException {
        Map params = new HashMap();
        params.put("appId", appId);
        return call("eleme.message.getNonReachedMessages", params);
    }

    /**
     * 获取未到达的推送消息实体
     *
     * @param appId 应用ID
     * @return 消息列表
     * @throws ServiceException 服务异常
     */
    public List getNonReachedOMessages(int appId) throws ServiceException {
        Map params = new HashMap();
        params.put("appId", appId);
        return call("eleme.message.getNonReachedOMessages", params);
    }

    /**
     * 获取http推送失败的消息
     *
     * @param request 查询推送失败消息日志结构体
     * @return 推送失败消息日志分页结构体
     * @throws ServiceException 服务异常
     */
    public FailedMessageLogResponse queryFailedMessageLog(QueryFailedMessageLogRequest request) throws ServiceException {
        Map params = new HashMap();
        params.put("request", request);
        return call("eleme.message.queryFailedMessageLog", params);
    }

    /**
     * 禁止推送消息设置
     *
     * @param disablePushRequest 禁止推送消息设置
     * @throws ServiceException 服务异常
     */
    public void disablePushConfig(DisablePushRequest disablePushRequest) throws ServiceException {
        Map params = new HashMap();
        params.put("disablePushRequest", disablePushRequest);
        call("eleme.message.disablePushConfig", params);
    }

    /**
     * 查询已经设置禁用推送的设置信息
     *
     * @param disablePushQuery 查询已经设置禁用推送的设置信息
     * @return  已经设置禁用推送的配置信息列表，分页展示
     * @throws ServiceException 服务异常
     */
    public DisablePushResponse queryDisablePush(DisablePushQuery disablePushQuery) throws ServiceException {
        Map params = new HashMap();
        params.put("disablePushQuery", disablePushQuery);
        return call("eleme.message.queryDisablePush", params);
    }
}