Package io.github.theword.queqiao.core.api

Class BroadcastApi

java.lang.Object
io.github.theword.queqiao.core.api.Api<MessagePayload,Void>
io.github.theword.queqiao.core.api.PlatformApi<MessagePayload,Void>
io.github.theword.queqiao.core.api.BroadcastApi
public final class BroadcastApi extends PlatformApi<MessagePayload,Void>
广播消息

协议名：broadcast，别名 send_msg。

Core 语义只有"广播成功 / 广播失败"，因此本 Api 不读取平台返回的任何数据， 只把失败结果交给 Api.mapPlatformResult(io.github.theword.queqiao.core.platform.PlatformResult<?>) 统一映射。

  • Constructor Details

  • Method Details

    • name

      public String name()
      Description copied from class: Api
      协议 api 字段的主名字，例如 "broadcast"
      Specified by:
      name in class Api<MessagePayload,Void>
      Returns:
      api 名字

    • aliases

      public Set<String> aliases()
      Description copied from class: Api
      别名

      用于"同一操作有多个协议名"的情况，例如 broadcast 与 send_msg 由同一个 Api 实例服务。

      Overrides:
      aliases in class Api<MessagePayload,Void>
      Returns:
      别名集合，默认空集合

    • doExecute

      protected Void doExecute(MessagePayload payload) throws ProtocolException
      Description copied from class: Api
      处理已经解析好的负载
      Specified by:
      doExecute in class Api<MessagePayload,Void>
      Parameters:
      payload - 负载，永不为 null
      Returns:
      处理结果
      Throws:
      ProtocolException - 处理失败