QChatService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.qchat.param.QChatKickOtherClientsParam;
import com.netease.nimlib.sdk.qchat.param.QChatLoginParam;
import com.netease.nimlib.sdk.qchat.result.QChatKickOtherClientsResult;
import com.netease.nimlib.sdk.qchat.result.QChatLoginResult;

/**
 * 圈组接口
 */
@NIMService("圈组服务")
public interface QChatService {
    /**
     * 登录接口
     * @param param
     * @return AbortableFuture 可取消操作；可设置回调函数，监听操作结果。
     * 回调中返回成功登陆后的客户端基本信息，以及同时在线的其他端列表
     */
    AbortableFuture<QChatLoginResult> login(QChatLoginParam param);


    /**
     * 登出接口
     *
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> logout();


    /**
     * 踢掉多端同时在线的其他端
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回被踢掉的客户端的deviceId列表
     */
    InvocationFuture<QChatKickOtherClientsResult> kickOtherClients(QChatKickOtherClientsParam param);
}