程序包 me.dreamvoid.miraimc.api

类 MiraiBot

java.lang.Object
me.dreamvoid.miraimc.api.MiraiBot
public class MiraiBot extends Object
Mirai Core 核心接口
作者:
DreamVoid

  • 方法详细资料

    • asBot

      public static MiraiBot asBot(net.mamoe.mirai.Bot bot)
      将一个机器人实例转换为MiraiBot
      参数:
      bot - 机器人实例
      返回:
      MiraiMC 机器人实例

    • getBot

      public static MiraiBot getBot(long account) throws NoSuchElementException
      获取指定机器人的实例
      参数:
      account - 机器人账号
      返回:
      MiraiMC 机器人实例
      抛出:
      NoSuchElementException - 不存在时抛出

    • getAvailableProtocol

      public static List<String> getAvailableProtocol()
      获取可用的 mirai 协议列表用于登录
      返回:
      协议列表

    • getOnlineBots

      public static List<Long> getOnlineBots()
      获取所有在线机器人
      返回:
      机器人账号列表

    • getFriend

      public MiraiFriend getFriend(long friendAccount)
      获取机器人指定好友的实例
      参数:
      friendAccount - 好友QQ号
      返回:
      MiraiMC 好友实例
      抛出:
      IllegalArgumentException - 当 friendAccount 无效时抛出

    • getGroup

      public MiraiGroup getGroup(long groupID)
      获取机器人指定群的实例
      参数:
      groupID - 群号
      返回:
      MiraiMC 群实例

    • doBotLogin

      public static void doBotLogin(long account, byte[] password, net.mamoe.mirai.utils.BotConfiguration.MiraiProtocol protocol)
      登录一个机器人账号
      [!] 不建议插件开发者调用此方法，建议引导用户通过MiraiMC指令登录机器人
      参数:
      account - 机器人账号
      password - 机器人密码MD5
      protocol - 协议类型

    • doBotLogin

      public static void doBotLogin(long account, String password, String protocol) throws IllegalArgumentException
      登录一个机器人账号
      [!] 不建议插件开发者调用此方法，建议引导用户通过MiraiMC指令登录机器人
      参数:
      account - 机器人账号
      password - 机器人密码
      protocol - 协议类型
      抛出:
      IllegalArgumentException - 协议不存在时抛出

    • doBotLogin

      public static void doBotLogin(long account, byte[] password, String protocol) throws IllegalArgumentException
      登录一个机器人账号
      [!] 不建议插件开发者调用此方法，建议引导用户通过MiraiMC指令登录机器人
      参数:
      account - 机器人账号
      password - 机器人密码MD5
      protocol - 协议名称
      抛出:
      IllegalArgumentException - 当参数无效或协议不存在时抛出
      从以下版本开始:
      1.7

    • doBotLogin

      public static void doBotLogin(long account, String password, net.mamoe.mirai.utils.BotConfiguration.MiraiProtocol protocol)
      登录一个机器人账号
      [!] 不建议插件开发者调用此方法，建议引导用户通过MiraiMC指令登录机器人
      参数:
      account - 机器人账号
      password - 机器人密码
      protocol - 协议类型
      抛出:
      IllegalArgumentException - 当参数无效时抛出
      从以下版本开始:
      1.7

    • doOnline

      public void doOnline()
      尝试将机器人设置为在线状态

    • doLogout

      @Deprecated public void doLogout()
      已过时。
      请使用 close()
      登出一个机器人账号

    • close

      public void close()
      关闭一个机器人实例，立刻停止有关此机器人的所有任务并登出机器人
      [!] 不建议插件开发者调用此方法，建议引导用户通过MiraiMC指令关闭机器人

    • isOnline

      public boolean isOnline()
      检查机器人是否在线
      返回:
      在线返回true，离线返回false

    • isExist

      public boolean isExist()
      检查机器人是否存在
      返回:
      存在返回true，不存在返回false

    • getNick

      public String getNick()
      获取机器人昵称
      返回:
      昵称

    • getID

      public long getID()
      获取机器人账号
      返回:
      QQ号

    • getFriendList

      public List<Long> getFriendList()
      获取机器人所有好友
      返回:
      好友QQ号列表

    • getGroupList

      public List<Long> getGroupList()
      获取机器人加入的所有群
      返回:
      群号列表

    • getStrangersList

      public List<Long> getStrangersList()
      获取机器人所有陌生人
      返回:
      陌生人QQ号列表

    • getAsFriend

      public MiraiFriend getAsFriend()
      将机器人作为好友获取好友实例
      返回:
      MiraiFriend 实例

    • uploadImage

      public String uploadImage(File image) throws IOException
      上传指定图片，获取图片 ID 用于发送消息
      参数:
      image - 图片文件
      返回:
      图片ID
      抛出:
      IOException - 上传文件发生异常时抛出

    • getOtherClient

      public MiraiOtherClient getOtherClient(long otherClient) throws NoSuchElementException
      获取指定的机器人登录的其他客户端
      参数:
      otherClient - 其他客户端ID
      返回:
      MiraiMC其他客户端实例
      抛出:
      NoSuchElementException - 当客户端不存在时抛出

    • getOtherClients

      public List<MiraiOtherClient> getOtherClients()
      获取机器人登录的所有其他客户端
      返回:
      MiraiOtherClient 实例数组

    • getFriendGroups

      public List<MiraiFriendGroup> getFriendGroups()
      获取好友分组列表
      返回:
      好友分组列表