EventSubscribeService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.event;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.event.model.Event;
import com.netease.nimlib.sdk.event.model.EventSubscribeRequest;
import com.netease.nimlib.sdk.event.model.EventSubscribeResult;
import java.util.List;

/**
 * 事件订阅服务
 */
@NIMService("事件订阅服务")
public interface EventSubscribeService {

    /**
     * 发布事件
     *
     * @param event 事件
     * @return InvocationFuture 可以设置回调函数。请求完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Event> publishEvent(Event event);

    /**
     * 订阅事件
     *
     * @param request 订阅请求信息 必须填写事件类型、事件发布者账号以及订阅有效期
     * @return InvocationFuture 可以设置回调函数。请求完成后才会调用，返回订阅失败的账号集合，如果数组长度为0则全部成功。如果出错，会有具体的错误代码。
     */
    InvocationFuture<List<String>> subscribeEvent(EventSubscribeRequest request);

    /**
     * 按账号取消指定事件的订阅关系
     *
     * @param request 取消订阅信息，只需填写事件类型和事件发布者账号集合（被订阅者集合）
     * @return InvocationFuture 可以设置回调函数。请求完成后才会调用，返回取消订阅失败的账号集合，如果数组长度为0则全部成功。如果出错，会有具体的错误代码。
     */
    InvocationFuture<List<String>> unSubscribeEvent(EventSubscribeRequest request);

    /**
     * 取消指定事件的全部订阅关系
     *
     * @param request 取消订阅信息，只需填写事件类型。
     * @return InvocationFuture 可以设置回调函数。请求完成后才会调用。如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> batchUnSubscribeEvent(EventSubscribeRequest request);

    /**
     * 查询指定事件类型的订阅关系
     *
     * @param request 查询订阅信息，必须填写事件类型、事件发布者账号,填写后将查询指定发布者的订阅关系。
     * @return InvocationFuture 可以设置回调函数。请求完成后才会调用。如果出错，会有具体的错误代码。
     */
    InvocationFuture<List<EventSubscribeResult>> querySubscribeEvent(EventSubscribeRequest request);
}