程序包 me.dreamvoid.miraimc.sponge.event.message.presend

类 MiraiFriendMessagePreSendEvent

java.lang.Object
org.spongepowered.api.event.impl.AbstractEvent
me.dreamvoid.miraimc.sponge.event.message.presend.MiraiFriendMessagePreSendEvent
所有已实现的接口:
org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.Event
public class MiraiFriendMessagePreSendEvent extends org.spongepowered.api.event.impl.AbstractEvent
(Sponge) 消息 - 主动发送消息前 - 好友消息

  • 字段概要

    从类继承的字段 org.spongepowered.api.event.impl.AbstractEvent

    currentOrder

  • 构造器概要

    构造器
    构造器
    说明
    MiraiFriendMessagePreSendEvent(net.mamoe.mirai.event.events.FriendMessagePreSendEvent event, org.spongepowered.api.event.Cause cause)
     

  • 方法概要

    修饰符和类型
    方法
    说明
    org.spongepowered.api.event.Cause
    cause()
     
    long
    getBotID()
    返回发送这条信息的机器人ID
    MiraiFriend
    getFriend()
    获取好友实例
    long
    getFriendID()
    返回目标好友的QQ号
    String
    getFriendNickName()
    返回目标好友的昵称
    String
    getFriendRemark()
    返回目标好友的备注名
    String
    getMessage()
    返回接收到的消息内容转换到字符串的结果
    此方法使用 contentToString()
    QQ 对话框中以纯文本方式会显示的消息内容，这适用于MC与QQ的消息互通等不方便展示原始内容的场景。
    String
    getMessageContent()
    已过时。 
    String
    getMessageToString()
    返回接收到的消息内容
    此方法使用 toString()
    Java 对象的 toString()，会尽可能包含多的信息用于调试作用，行为可能不确定
    如需处理常规消息内容，请使用 getMessageContent()
    long
    getTargetID()
    返回接收者ID
    boolean
    isCancelled()
    消息是否已被取消发送
    void
    setCancelled(boolean cancel)
    取消消息的发送
    请注意，无论 cancel 参数设为什么，只要被取消过，就不能撤销。
    void
    setMessage(String message)
    设置将要发送的消息内容 支持 Mirai Code
    String
    toString()
    获取原始事件内容
    [!]

    从类继承的方法 org.spongepowered.api.event.impl.AbstractEvent

    init

    从类继承的方法 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    从接口继承的方法 org.spongepowered.api.event.Event

    context, source

  • 构造器详细资料

    • MiraiFriendMessagePreSendEvent

      public MiraiFriendMessagePreSendEvent(net.mamoe.mirai.event.events.FriendMessagePreSendEvent event, org.spongepowered.api.event.Cause cause)

  • 方法详细资料

    • getBotID

      public long getBotID()
      返回发送这条信息的机器人ID
      返回:
      机器人ID

    • getFriendID

      public long getFriendID()
      返回目标好友的QQ号
      返回:
      好友QQ号

    • getFriendNickName

      public String getFriendNickName()
      返回目标好友的昵称
      返回:
      昵称

    • getFriendRemark

      public String getFriendRemark()
      返回目标好友的备注名
      返回:
      备注名

    • getFriend

      public MiraiFriend getFriend()
      获取好友实例
      返回:
      MiraiFriend 实例

    • getTargetID

      public long getTargetID()
      返回接收者ID
      返回:
      可以是QQ号或群号

    • getMessage

      public String getMessage()
      返回接收到的消息内容转换到字符串的结果
      此方法使用 contentToString()
      QQ 对话框中以纯文本方式会显示的消息内容，这适用于MC与QQ的消息互通等不方便展示原始内容的场景。
      无法用纯文字表示的消息会丢失信息，如任何图片都是 [图片]
      返回:
      转换字符串后的消息内容

    • getMessageContent

      @Deprecated public String getMessageContent()
      已过时。
      返回接收到的消息内容转换到字符串的结果
      此方法使用 contentToString()
      QQ 对话框中以纯文本方式会显示的消息内容，这适用于MC与QQ的消息互通等不方便展示原始内容的场景。
      无法用纯文字表示的消息会丢失信息，如任何图片都是 [图片]
      返回:
      转换字符串后的消息内容
      另请参阅:

    • getMessageToString

      public String getMessageToString()
      返回接收到的消息内容
      此方法使用 toString()
      Java 对象的 toString()，会尽可能包含多的信息用于调试作用，行为可能不确定
      如需处理常规消息内容，请使用 getMessageContent()
      返回:
      原始消息内容

    • setMessage

      public void setMessage(String message)
      设置将要发送的消息内容 支持 Mirai Code
      参数:
      message - 带 Mirai Code 的消息

    • isCancelled

      public boolean isCancelled()
      消息是否已被取消发送
      指定者:
      isCancelled 在接口中 org.spongepowered.api.event.Cancellable
      返回:
      如果消息被取消发送，返回true

    • setCancelled

      public void setCancelled(boolean cancel)
      取消消息的发送
      请注意，无论 cancel 参数设为什么，只要被取消过，就不能撤销。
      也就是说，已取消的事件永远不会继续发送消息。
      指定者:
      setCancelled 在接口中 org.spongepowered.api.event.Cancellable
      参数:
      cancel - 调用此方法将忽略本参数，无论设为什么

    • toString

      public String toString()
      获取原始事件内容
      [!] 不推荐使用
      覆盖:
      toString 在类中 Object
      返回:
      原始事件内容

    • cause

      @NotNull public org.spongepowered.api.event.Cause cause()
      指定者:
      cause 在接口中 org.spongepowered.api.event.Event