package oco

Get desktop application:
View/edit binary Protocol Buffers messages

The RPC service that controls the chat bot.

• rpc Join (JoinRequest, JoinResponse)

  robot.proto:10

  Instructs the bot to join a room.

  message JoinRequest

  robot.proto:20

  Request message for the Join method.

  • optional Room room = 1

    The room to be joined.

  message JoinResponse

  robot.proto:25

  Response message for the Join method.

  (message has no fields)

• rpc Listen (ListenRequest, stream Event)

  robot.proto:12

  Listens to a stream of incoming events.

  message ListenRequest

  robot.proto:28

  Request message for the Listen method.

  • string plugin_id = 1

    Identifies the listening plugin.

  message Event

  core.proto:6

  An event received over the Listen stream.

  • oneof type

    • MatchedMessage matched_message = 1

      An incoming message that matched a chat route.

• rpc Part (PartRequest, PartResponse)

  robot.proto:14

  Instructs the bot to part from a room.

  message PartRequest

  robot.proto:33

  Request message for the Part method.

  • optional Room room = 1

    The room to be parted.

  message PartResponse

  robot.proto:38

  Response message for the Part method.

  (message has no fields)

• rpc SendMessages (SendMessagesRequest, SendMessagesResponse)

  robot.proto:16

  Sends one or more messages to a user or room.

  message SendMessagesRequest

  robot.proto:41

  Request message for the SendMessages method.

  • bool WithMention = 1

    Whether or not to prepend the user's mention name to the messages.

  • repeated Message messages = 2

    The messages to send.

  message SendMessagesResponse

  robot.proto:47

  Response message for the SendMessages method.

  (message has no fields)

An incoming message that matched a chat route.

Used in: Event

• optional Message message = 1

  The message.

• string pattern = 2

  The regular expression that matched.

A chat message.

Used in: MatchedMessage, SendMessagesRequest

• string body = 1

  The body of the message.

• optional Source source = 2

  The source of an incoming message or target of an outgoing message.

A chat room.

Used in: JoinRequest, PartRequest, Source

• string id = 1

  A unique ID for the room.

• string name = 2

  A human-readable name for the room.

The user/room that sent an incoming message or the user/room to send an outgoing messsage to.

Used in: Message

• optional User user = 1

  The user.

• optional Room room = 2

  The room.

A user of the chat service.

Used in: Source

• string id = 1

  A unique ID for the user.

• string name = 2

  A human-readable name for the user.

• string mention_name = 3

  A short name that alerts the user when it appears in a message.