RobotService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.robot;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.robot.model.NimRobotInfo;

import java.util.List;

/**
 * 机器人操作相关接口
 */

@NIMService("机器人服务")
public interface RobotService {

    /**
     * 获取本地所有有效的机器人
     *
     * @return 机器人信息集合
     */
    List<NimRobotInfo> getAllRobots();

    /**
     * 根据账号本地获取机器人信息
     *
     * @param account 机器人账号
     * @return 机器人信息
     */
    NimRobotInfo getRobotInfo(String account);

    /**
     * 根据账号集合本地获取机器人信息集合
     *
     * @param accounts 机器人账号集合
     * @return 机器人信息集合
     */
    List<NimRobotInfo> getRobotInfoList(List<String> accounts);

    /**
     * 判断该账号是否是机器人账号
     *
     * @param account 用户账号
     * @return 该账号是否为机器人
     */
    boolean isRobot(String account);

    /**
     * 获取全部机器人列表，和服务端同步
     *
     * @return InvocationFuture 可设置回调函数。回调中返回操作成功或者失败具体的错误码。
     */
    InvocationFuture<List<NimRobotInfo>> pullAllRobots();
}