Module seabird::proto::seabird [−][src]
Modules
Nested message and enum types in ChatEvent.
Generated client implementations.
Generated server implementations.
Nested message and enum types in ChatRequest.
Nested message and enum types in Event.
Generated client implementations.
Generated server implementations.
Structs
Get info about a specific connected backend.
ChangeChannelEvent will occur when a channel’s display name or topic is updated.
ChatEvent contains all the different event types a chat backend can emit. Note that these are slightly different to the seabird.Event types as channels here will not be mapped to UUIDs and some events are only to support the data that seabird-core tracks.
Each ChatRequest has an ID (which can be attached to requests coming from core) and an inner message type. Having an ID allows us to route an event back to the requestor without having the chat backend implement a service.
CommandMetadata groups together a command’s name along with short in-line help and the full private help.
A request for metadata about the running core instance.
Metadata about the running core instance.
This is a marker event to respond to seabird-core that performing an action has failed. Failed events do not in any way affect chat backends. They serve only to notify plugins of failed actions.
HelloChatEvent MUST be the first event sent by the chat backend. If a different event is sent, the connection will be closed. The chat backend MUST provide an ID unique between all running instances of this type in the backend_info. If the ID is not provided or is not unique, the connection will be closed.
JoinChannelEvent will be sent when a user joins a channel. The topic SHOULD be included if possible, but it can be sent in a topic update event later.
JoinChannelChatRequest requests for the bot to join a channel with the given name. Either JoinChannelEvent or FailedChatEvent SHOULD be returned in response if possible.
Request to join a channel.
LeaveChannelEvent will be sent when a user leaves a channel.
LeaveChannelChatRequest requests for the bot to leave the channel with the given ID. Either LeaveChannelEvent or FailedChatEvent SHOULD be returned in response if possible.
Request to leave a channel.
Request to list all connected backends.
MetadataChatEvent will be sent in response to a MetadataChatRequest. It is not sent directly without a corresponding request from seabird-core.
MetadataChatRequest requests metadata about the given backend. seabird-core expects the backend to respond with a MetadataChatEvent object.
PerformActionRequest is often known as /me. Either SuccessChatEvent or FailedChatEvent SHOULD be returned in response if possible. The PerformActionEvent written to the chat backend’s connection MUST NOT also be sent to the chat backend’s event stream.
PerformActionEvent will be emitted whenever a plugin or other client calls PerformAction. Note that this will be emitted every time PerformAction is called, not when it succeeds. The additional sender param refers to the client sending the message.
Perform an action in a given channel.
PerformPrivateActionRequest is often known as /me. Either SuccessChatEvent or FailedChatEvent SHOULD be returned in response if possible. The PerformActionEvent written to the chat backend’s connection MUST NOT also be sent to the chat backend’s event stream.
PerformPrivateActionEvent will be emitted whenever a plugin or other client calls PerformPrivateAction. Note that this will be emitted every time PerformPrivateAction is called, not when it succeeds. The additional sender param refers to the client sending the message.
Perform an action in a private message.
SendMessageChatRequest requests for a message to be sent to a given channel. Either SuccessChatEvent or FailedChatEvent SHOULD be returned in response if possible. The MessageEvent written to the chat backend’s connection MUST NOT also be sent to the chat backend’s event stream.
SendMessageEvent will be emitted whenever a plugin or other client calls SendMessage. Note that this will be emitted every time SendMessage is called, not when it succeeds. The additional sender param refers to the client sending the message.
Send a message to a given a channel.
SendPrivateMessageChatRequest requests for a message to be sent to a given user. Either SuccessChatEvent or FailedChatEvent SHOULD be returned in response if possible. The PrivateMessageEvent written to the chat backend’s connection MUST NOT also be sent to the chat backend’s event stream.
SendPrivateMessageEvent will be emitted whenever a plugin or other client calls SendPrivateMessage. Note that this will be emitted every time SendPrivateMessage is called, not when it succeeds.The additional sender param refers to the client sending the message.
Send a private message to a given user.
This is a marker event to respond to seabird-core that performing an action has succeeded. Note that most requests have explicit associated Events, so this should only be used in absence of a matching event.
UpdateChannelInfoChatRequest requests for a the channel to be updated with the given metadata. Either ChangeChannelEvent or FailedChatEvent SHOULD be returned in response if possible.