pb

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2021 License: MIT Imports: 9 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_common_proto protoreflect.FileDescriptor
View Source
var File_seabird_chat_ingest_proto protoreflect.FileDescriptor
View Source
var File_seabird_proto protoreflect.FileDescriptor

Functions

func RegisterChatIngestServer

func RegisterChatIngestServer(s grpc.ServiceRegistrar, srv ChatIngestServer)

func RegisterSeabirdServer

func RegisterSeabirdServer(s grpc.ServiceRegistrar, srv SeabirdServer)

Types

type ActionEvent

type ActionEvent struct {
	Source *ChannelSource `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Text   string         `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

ActionEvent will be sent when a user takes an action in a channel. This is often triggered with /me.

func (*ActionEvent) Descriptor deprecated

func (*ActionEvent) Descriptor() ([]byte, []int)

Deprecated: Use ActionEvent.ProtoReflect.Descriptor instead.

func (*ActionEvent) GetSource

func (x *ActionEvent) GetSource() *ChannelSource

func (*ActionEvent) GetText

func (x *ActionEvent) GetText() string

func (*ActionEvent) ProtoMessage

func (*ActionEvent) ProtoMessage()

func (*ActionEvent) ProtoReflect

func (x *ActionEvent) ProtoReflect() protoreflect.Message

func (*ActionEvent) Reset

func (x *ActionEvent) Reset()

func (*ActionEvent) String

func (x *ActionEvent) String() string

type Backend

type Backend struct {
	Id   string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

When sent by a chat backend, the ID MAY optionally be used as a hint to the frontend to get the same external ID on reconnection. When sent by core to a plugin, the ID MUST be an ID pointing to an exact backend instance.

func (*Backend) Descriptor deprecated

func (*Backend) Descriptor() ([]byte, []int)

Deprecated: Use Backend.ProtoReflect.Descriptor instead.

func (*Backend) GetId

func (x *Backend) GetId() string

func (*Backend) GetType

func (x *Backend) GetType() string

func (*Backend) ProtoMessage

func (*Backend) ProtoMessage()

func (*Backend) ProtoReflect

func (x *Backend) ProtoReflect() protoreflect.Message

func (*Backend) Reset

func (x *Backend) Reset()

func (*Backend) String

func (x *Backend) String() string

type BackendInfoRequest

type BackendInfoRequest struct {
	BackendId string `protobuf:"bytes,1,opt,name=backend_id,json=backendId,proto3" json:"backend_id,omitempty"`
	// contains filtered or unexported fields
}

Get info about a specific connected backend.

func (*BackendInfoRequest) Descriptor deprecated

func (*BackendInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use BackendInfoRequest.ProtoReflect.Descriptor instead.

func (*BackendInfoRequest) GetBackendId

func (x *BackendInfoRequest) GetBackendId() string

func (*BackendInfoRequest) ProtoMessage

func (*BackendInfoRequest) ProtoMessage()

func (*BackendInfoRequest) ProtoReflect

func (x *BackendInfoRequest) ProtoReflect() protoreflect.Message

func (*BackendInfoRequest) Reset

func (x *BackendInfoRequest) Reset()

func (*BackendInfoRequest) String

func (x *BackendInfoRequest) String() string

type BackendInfoResponse

type BackendInfoResponse struct {
	Backend  *Backend          `protobuf:"bytes,1,opt,name=Backend,proto3" json:"Backend,omitempty"`
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*BackendInfoResponse) Descriptor deprecated

func (*BackendInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use BackendInfoResponse.ProtoReflect.Descriptor instead.

func (*BackendInfoResponse) GetBackend

func (x *BackendInfoResponse) GetBackend() *Backend

func (*BackendInfoResponse) GetMetadata added in v0.3.0

func (x *BackendInfoResponse) GetMetadata() map[string]string

func (*BackendInfoResponse) ProtoMessage

func (*BackendInfoResponse) ProtoMessage()

func (*BackendInfoResponse) ProtoReflect

func (x *BackendInfoResponse) ProtoReflect() protoreflect.Message

func (*BackendInfoResponse) Reset

func (x *BackendInfoResponse) Reset()

func (*BackendInfoResponse) String

func (x *BackendInfoResponse) String() string

type ChangeChannelChatEvent

type ChangeChannelChatEvent struct {
	ChannelId   string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	Topic       string `protobuf:"bytes,3,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

ChangeChannelEvent will occur when a channel's display name or topic is updated.

func (*ChangeChannelChatEvent) Descriptor deprecated

func (*ChangeChannelChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use ChangeChannelChatEvent.ProtoReflect.Descriptor instead.

func (*ChangeChannelChatEvent) GetChannelId

func (x *ChangeChannelChatEvent) GetChannelId() string

func (*ChangeChannelChatEvent) GetDisplayName

func (x *ChangeChannelChatEvent) GetDisplayName() string

func (*ChangeChannelChatEvent) GetTopic

func (x *ChangeChannelChatEvent) GetTopic() string

func (*ChangeChannelChatEvent) ProtoMessage

func (*ChangeChannelChatEvent) ProtoMessage()

func (*ChangeChannelChatEvent) ProtoReflect

func (x *ChangeChannelChatEvent) ProtoReflect() protoreflect.Message

func (*ChangeChannelChatEvent) Reset

func (x *ChangeChannelChatEvent) Reset()

func (*ChangeChannelChatEvent) String

func (x *ChangeChannelChatEvent) String() string

type Channel

type Channel struct {
	Id          string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	Topic       string `protobuf:"bytes,3,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

When sent by a chat backend, the ID MUST be unique across channels in that running backend. Failure to follow this will result in incorrect information being sent to plugins. When sent by core to a plugin, the ID MUST be an ID pointing to an instance of a channel on chat backend.

func (*Channel) Descriptor deprecated

func (*Channel) Descriptor() ([]byte, []int)

Deprecated: Use Channel.ProtoReflect.Descriptor instead.

func (*Channel) GetDisplayName

func (x *Channel) GetDisplayName() string

func (*Channel) GetId

func (x *Channel) GetId() string

func (*Channel) GetTopic

func (x *Channel) GetTopic() string

func (*Channel) ProtoMessage

func (*Channel) ProtoMessage()

func (*Channel) ProtoReflect

func (x *Channel) ProtoReflect() protoreflect.Message

func (*Channel) Reset

func (x *Channel) Reset()

func (*Channel) String

func (x *Channel) String() string

type ChannelInfoRequest

type ChannelInfoRequest struct {
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ChannelInfoRequest) Descriptor deprecated

func (*ChannelInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use ChannelInfoRequest.ProtoReflect.Descriptor instead.

func (*ChannelInfoRequest) GetChannelId

func (x *ChannelInfoRequest) GetChannelId() string

func (*ChannelInfoRequest) ProtoMessage

func (*ChannelInfoRequest) ProtoMessage()

func (*ChannelInfoRequest) ProtoReflect

func (x *ChannelInfoRequest) ProtoReflect() protoreflect.Message

func (*ChannelInfoRequest) Reset

func (x *ChannelInfoRequest) Reset()

func (*ChannelInfoRequest) String

func (x *ChannelInfoRequest) String() string

type ChannelInfoResponse

type ChannelInfoResponse struct {
	Channel *Channel `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
	// contains filtered or unexported fields
}

func (*ChannelInfoResponse) Descriptor deprecated

func (*ChannelInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use ChannelInfoResponse.ProtoReflect.Descriptor instead.

func (*ChannelInfoResponse) GetChannel

func (x *ChannelInfoResponse) GetChannel() *Channel

func (*ChannelInfoResponse) ProtoMessage

func (*ChannelInfoResponse) ProtoMessage()

func (*ChannelInfoResponse) ProtoReflect

func (x *ChannelInfoResponse) ProtoReflect() protoreflect.Message

func (*ChannelInfoResponse) Reset

func (x *ChannelInfoResponse) Reset()

func (*ChannelInfoResponse) String

func (x *ChannelInfoResponse) String() string

type ChannelSource

type ChannelSource struct {
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	User      *User  `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

ChannelSource represents where a message came from. Note that User is used rather than just an ID so any clients can have access to the name as well. This may change in the future.

func (*ChannelSource) Descriptor deprecated

func (*ChannelSource) Descriptor() ([]byte, []int)

Deprecated: Use ChannelSource.ProtoReflect.Descriptor instead.

func (*ChannelSource) GetChannelId

func (x *ChannelSource) GetChannelId() string

func (*ChannelSource) GetUser

func (x *ChannelSource) GetUser() *User

func (*ChannelSource) ProtoMessage

func (*ChannelSource) ProtoMessage()

func (*ChannelSource) ProtoReflect

func (x *ChannelSource) ProtoReflect() protoreflect.Message

func (*ChannelSource) Reset

func (x *ChannelSource) Reset()

func (*ChannelSource) String

func (x *ChannelSource) String() string

type ChatEvent

type ChatEvent struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Inner:
	//	*ChatEvent_Hello
	//	*ChatEvent_Success
	//	*ChatEvent_Failed
	//	*ChatEvent_Message
	//	*ChatEvent_PrivateMessage
	//	*ChatEvent_Mention
	//	*ChatEvent_Command
	//	*ChatEvent_Action
	//	*ChatEvent_PrivateAction
	//	*ChatEvent_JoinChannel
	//	*ChatEvent_LeaveChannel
	//	*ChatEvent_ChangeChannel
	//	*ChatEvent_Metadata
	Inner isChatEvent_Inner `protobuf_oneof:"inner"`
	Tags  map[string]string `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

HelloChatEvent is the only message type that is required for a chat backend to work.

Core may be configured with both time-based and load-based request failure mechanisms. It can fail any action and serve that as an error to plugins. If an ID is included which has timed out in core or otherwise does not exist, it will be ignored.

func (*ChatEvent) Descriptor deprecated

func (*ChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use ChatEvent.ProtoReflect.Descriptor instead.

func (*ChatEvent) GetAction

func (x *ChatEvent) GetAction() *ActionEvent

func (*ChatEvent) GetChangeChannel

func (x *ChatEvent) GetChangeChannel() *ChangeChannelChatEvent

func (*ChatEvent) GetCommand

func (x *ChatEvent) GetCommand() *CommandEvent

func (*ChatEvent) GetFailed

func (x *ChatEvent) GetFailed() *FailedChatEvent

func (*ChatEvent) GetHello

func (x *ChatEvent) GetHello() *HelloChatEvent

func (*ChatEvent) GetId

func (x *ChatEvent) GetId() string

func (*ChatEvent) GetInner

func (m *ChatEvent) GetInner() isChatEvent_Inner

func (*ChatEvent) GetJoinChannel

func (x *ChatEvent) GetJoinChannel() *JoinChannelChatEvent

func (*ChatEvent) GetLeaveChannel

func (x *ChatEvent) GetLeaveChannel() *LeaveChannelChatEvent

func (*ChatEvent) GetMention

func (x *ChatEvent) GetMention() *MentionEvent

func (*ChatEvent) GetMessage

func (x *ChatEvent) GetMessage() *MessageEvent

func (*ChatEvent) GetMetadata added in v0.3.0

func (x *ChatEvent) GetMetadata() *MetadataChatEvent

func (*ChatEvent) GetPrivateAction

func (x *ChatEvent) GetPrivateAction() *PrivateActionEvent

func (*ChatEvent) GetPrivateMessage

func (x *ChatEvent) GetPrivateMessage() *PrivateMessageEvent

func (*ChatEvent) GetSuccess

func (x *ChatEvent) GetSuccess() *SuccessChatEvent

func (*ChatEvent) GetTags added in v0.4.0

func (x *ChatEvent) GetTags() map[string]string

func (*ChatEvent) ProtoMessage

func (*ChatEvent) ProtoMessage()

func (*ChatEvent) ProtoReflect

func (x *ChatEvent) ProtoReflect() protoreflect.Message

func (*ChatEvent) Reset

func (x *ChatEvent) Reset()

func (*ChatEvent) String

func (x *ChatEvent) String() string

type ChatEvent_Action

type ChatEvent_Action struct {
	Action *ActionEvent `protobuf:"bytes,12,opt,name=action,proto3,oneof"`
}

type ChatEvent_ChangeChannel

type ChatEvent_ChangeChannel struct {
	ChangeChannel *ChangeChannelChatEvent `protobuf:"bytes,11,opt,name=change_channel,json=changeChannel,proto3,oneof"`
}

type ChatEvent_Command

type ChatEvent_Command struct {
	Command *CommandEvent `protobuf:"bytes,8,opt,name=command,proto3,oneof"`
}

type ChatEvent_Failed

type ChatEvent_Failed struct {
	Failed *FailedChatEvent `protobuf:"bytes,4,opt,name=failed,proto3,oneof"`
}

type ChatEvent_Hello

type ChatEvent_Hello struct {
	// Seabird-internal event types
	Hello *HelloChatEvent `protobuf:"bytes,2,opt,name=hello,proto3,oneof"`
}

type ChatEvent_JoinChannel

type ChatEvent_JoinChannel struct {
	// Channel changes
	JoinChannel *JoinChannelChatEvent `protobuf:"bytes,9,opt,name=join_channel,json=joinChannel,proto3,oneof"`
}

type ChatEvent_LeaveChannel

type ChatEvent_LeaveChannel struct {
	LeaveChannel *LeaveChannelChatEvent `protobuf:"bytes,10,opt,name=leave_channel,json=leaveChannel,proto3,oneof"`
}

type ChatEvent_Mention

type ChatEvent_Mention struct {
	Mention *MentionEvent `protobuf:"bytes,7,opt,name=mention,proto3,oneof"`
}

type ChatEvent_Message

type ChatEvent_Message struct {
	// Messages from the service
	Message *MessageEvent `protobuf:"bytes,5,opt,name=message,proto3,oneof"`
}

type ChatEvent_Metadata added in v0.3.0

type ChatEvent_Metadata struct {
	// Introspection
	Metadata *MetadataChatEvent `protobuf:"bytes,14,opt,name=metadata,proto3,oneof"`
}

type ChatEvent_PrivateAction

type ChatEvent_PrivateAction struct {
	PrivateAction *PrivateActionEvent `protobuf:"bytes,13,opt,name=private_action,json=privateAction,proto3,oneof"`
}

type ChatEvent_PrivateMessage

type ChatEvent_PrivateMessage struct {
	PrivateMessage *PrivateMessageEvent `protobuf:"bytes,6,opt,name=private_message,json=privateMessage,proto3,oneof"`
}

type ChatEvent_Success

type ChatEvent_Success struct {
	Success *SuccessChatEvent `protobuf:"bytes,3,opt,name=success,proto3,oneof"`
}

type ChatIngestClient

type ChatIngestClient interface {
	IngestEvents(ctx context.Context, opts ...grpc.CallOption) (ChatIngest_IngestEventsClient, error)
}

ChatIngestClient is the client API for ChatIngest service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewChatIngestClient

func NewChatIngestClient(cc grpc.ClientConnInterface) ChatIngestClient

type ChatIngestServer

type ChatIngestServer interface {
	IngestEvents(ChatIngest_IngestEventsServer) error
	// contains filtered or unexported methods
}

ChatIngestServer is the server API for ChatIngest service. All implementations must embed UnimplementedChatIngestServer for forward compatibility

type ChatIngest_IngestEventsClient

type ChatIngest_IngestEventsClient interface {
	Send(*ChatEvent) error
	Recv() (*ChatRequest, error)
	grpc.ClientStream
}

type ChatIngest_IngestEventsServer

type ChatIngest_IngestEventsServer interface {
	Send(*ChatRequest) error
	Recv() (*ChatEvent, error)
	grpc.ServerStream
}

type ChatRequest

type ChatRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Inner:
	//	*ChatRequest_SendMessage
	//	*ChatRequest_SendPrivateMessage
	//	*ChatRequest_JoinChannel
	//	*ChatRequest_LeaveChannel
	//	*ChatRequest_UpdateChannelInfo
	//	*ChatRequest_PerformAction
	//	*ChatRequest_PerformPrivateAction
	//	*ChatRequest_Metadata
	Inner isChatRequest_Inner `protobuf_oneof:"inner"`
	// contains filtered or unexported fields
}

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.

When a request does not get a response, the action may still happen and be sent to the event stream, but the plugin may receive a timed out request.

func (*ChatRequest) Descriptor deprecated

func (*ChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use ChatRequest.ProtoReflect.Descriptor instead.

func (*ChatRequest) GetId

func (x *ChatRequest) GetId() string

func (*ChatRequest) GetInner

func (m *ChatRequest) GetInner() isChatRequest_Inner

func (*ChatRequest) GetJoinChannel

func (x *ChatRequest) GetJoinChannel() *JoinChannelChatRequest

func (*ChatRequest) GetLeaveChannel

func (x *ChatRequest) GetLeaveChannel() *LeaveChannelChatRequest

func (*ChatRequest) GetMetadata added in v0.3.0

func (x *ChatRequest) GetMetadata() *MetadataChatRequest

func (*ChatRequest) GetPerformAction

func (x *ChatRequest) GetPerformAction() *PerformActionChatRequest

func (*ChatRequest) GetPerformPrivateAction

func (x *ChatRequest) GetPerformPrivateAction() *PerformPrivateActionChatRequest

func (*ChatRequest) GetSendMessage

func (x *ChatRequest) GetSendMessage() *SendMessageChatRequest

func (*ChatRequest) GetSendPrivateMessage

func (x *ChatRequest) GetSendPrivateMessage() *SendPrivateMessageChatRequest

func (*ChatRequest) GetUpdateChannelInfo

func (x *ChatRequest) GetUpdateChannelInfo() *UpdateChannelInfoChatRequest

func (*ChatRequest) ProtoMessage

func (*ChatRequest) ProtoMessage()

func (*ChatRequest) ProtoReflect

func (x *ChatRequest) ProtoReflect() protoreflect.Message

func (*ChatRequest) Reset

func (x *ChatRequest) Reset()

func (*ChatRequest) String

func (x *ChatRequest) String() string

type ChatRequest_JoinChannel

type ChatRequest_JoinChannel struct {
	JoinChannel *JoinChannelChatRequest `protobuf:"bytes,4,opt,name=join_channel,json=joinChannel,proto3,oneof"`
}

type ChatRequest_LeaveChannel

type ChatRequest_LeaveChannel struct {
	LeaveChannel *LeaveChannelChatRequest `protobuf:"bytes,5,opt,name=leave_channel,json=leaveChannel,proto3,oneof"`
}

type ChatRequest_Metadata added in v0.3.0

type ChatRequest_Metadata struct {
	Metadata *MetadataChatRequest `protobuf:"bytes,9,opt,name=metadata,proto3,oneof"`
}

type ChatRequest_PerformAction

type ChatRequest_PerformAction struct {
	PerformAction *PerformActionChatRequest `protobuf:"bytes,7,opt,name=perform_action,json=performAction,proto3,oneof"`
}

type ChatRequest_PerformPrivateAction

type ChatRequest_PerformPrivateAction struct {
	PerformPrivateAction *PerformPrivateActionChatRequest `protobuf:"bytes,8,opt,name=perform_private_action,json=performPrivateAction,proto3,oneof"`
}

type ChatRequest_SendMessage

type ChatRequest_SendMessage struct {
	SendMessage *SendMessageChatRequest `protobuf:"bytes,2,opt,name=send_message,json=sendMessage,proto3,oneof"`
}

type ChatRequest_SendPrivateMessage

type ChatRequest_SendPrivateMessage struct {
	SendPrivateMessage *SendPrivateMessageChatRequest `protobuf:"bytes,3,opt,name=send_private_message,json=sendPrivateMessage,proto3,oneof"`
}

type ChatRequest_UpdateChannelInfo

type ChatRequest_UpdateChannelInfo struct {
	UpdateChannelInfo *UpdateChannelInfoChatRequest `protobuf:"bytes,6,opt,name=update_channel_info,json=updateChannelInfo,proto3,oneof"`
}

type CommandEvent

type CommandEvent struct {
	Source  *ChannelSource `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Command string         `protobuf:"bytes,2,opt,name=command,proto3" json:"command,omitempty"`
	Arg     string         `protobuf:"bytes,3,opt,name=arg,proto3" json:"arg,omitempty"`
	// contains filtered or unexported fields
}

CommandEvent will be sent when a user issues a command in a channel. Commands cannot be issued via private message. If a message is parsed as a command, it MUST NOT be also sent as another message type.

func (*CommandEvent) Descriptor deprecated

func (*CommandEvent) Descriptor() ([]byte, []int)

Deprecated: Use CommandEvent.ProtoReflect.Descriptor instead.

func (*CommandEvent) GetArg

func (x *CommandEvent) GetArg() string

func (*CommandEvent) GetCommand

func (x *CommandEvent) GetCommand() string

func (*CommandEvent) GetSource

func (x *CommandEvent) GetSource() *ChannelSource

func (*CommandEvent) ProtoMessage

func (*CommandEvent) ProtoMessage()

func (*CommandEvent) ProtoReflect

func (x *CommandEvent) ProtoReflect() protoreflect.Message

func (*CommandEvent) Reset

func (x *CommandEvent) Reset()

func (*CommandEvent) String

func (x *CommandEvent) String() string

type CommandMetadata

type CommandMetadata struct {
	Name      string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	ShortHelp string `protobuf:"bytes,2,opt,name=short_help,json=shortHelp,proto3" json:"short_help,omitempty"`
	FullHelp  string `protobuf:"bytes,3,opt,name=full_help,json=fullHelp,proto3" json:"full_help,omitempty"`
	// contains filtered or unexported fields
}

CommandMetadata groups together a command's name along with short in-line help and the full private help.

An example for the "help" command might be a name of "help", a short_help of "<command>" and an long help of "With no arguments, lists all available commands. With an argument, display the long help for an item."

func (*CommandMetadata) Descriptor deprecated

func (*CommandMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CommandMetadata.ProtoReflect.Descriptor instead.

func (*CommandMetadata) GetFullHelp

func (x *CommandMetadata) GetFullHelp() string

func (*CommandMetadata) GetName

func (x *CommandMetadata) GetName() string

func (*CommandMetadata) GetShortHelp

func (x *CommandMetadata) GetShortHelp() string

func (*CommandMetadata) ProtoMessage

func (*CommandMetadata) ProtoMessage()

func (*CommandMetadata) ProtoReflect

func (x *CommandMetadata) ProtoReflect() protoreflect.Message

func (*CommandMetadata) Reset

func (x *CommandMetadata) Reset()

func (*CommandMetadata) String

func (x *CommandMetadata) String() string

type CommandsRequest added in v0.4.0

type CommandsRequest struct {
	// contains filtered or unexported fields
}

func (*CommandsRequest) Descriptor deprecated added in v0.4.0

func (*CommandsRequest) Descriptor() ([]byte, []int)

Deprecated: Use CommandsRequest.ProtoReflect.Descriptor instead.

func (*CommandsRequest) ProtoMessage added in v0.4.0

func (*CommandsRequest) ProtoMessage()

func (*CommandsRequest) ProtoReflect added in v0.4.0

func (x *CommandsRequest) ProtoReflect() protoreflect.Message

func (*CommandsRequest) Reset added in v0.4.0

func (x *CommandsRequest) Reset()

func (*CommandsRequest) String added in v0.4.0

func (x *CommandsRequest) String() string

type CommandsResponse added in v0.4.0

type CommandsResponse struct {
	Commands map[string]*CommandMetadata `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CommandsResponse) Descriptor deprecated added in v0.4.0

func (*CommandsResponse) Descriptor() ([]byte, []int)

Deprecated: Use CommandsResponse.ProtoReflect.Descriptor instead.

func (*CommandsResponse) GetCommands added in v0.4.0

func (x *CommandsResponse) GetCommands() map[string]*CommandMetadata

func (*CommandsResponse) ProtoMessage added in v0.4.0

func (*CommandsResponse) ProtoMessage()

func (*CommandsResponse) ProtoReflect added in v0.4.0

func (x *CommandsResponse) ProtoReflect() protoreflect.Message

func (*CommandsResponse) Reset added in v0.4.0

func (x *CommandsResponse) Reset()

func (*CommandsResponse) String added in v0.4.0

func (x *CommandsResponse) String() string

type CoreInfoRequest

type CoreInfoRequest struct {
	// contains filtered or unexported fields
}

A request for metadata about the running core instance.

func (*CoreInfoRequest) Descriptor deprecated

func (*CoreInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use CoreInfoRequest.ProtoReflect.Descriptor instead.

func (*CoreInfoRequest) ProtoMessage

func (*CoreInfoRequest) ProtoMessage()

func (*CoreInfoRequest) ProtoReflect

func (x *CoreInfoRequest) ProtoReflect() protoreflect.Message

func (*CoreInfoRequest) Reset

func (x *CoreInfoRequest) Reset()

func (*CoreInfoRequest) String

func (x *CoreInfoRequest) String() string

type CoreInfoResponse

type CoreInfoResponse struct {
	StartupTimestamp uint64 `protobuf:"varint,1,opt,name=startup_timestamp,json=startupTimestamp,proto3" json:"startup_timestamp,omitempty"`
	CurrentTimestamp uint64 `protobuf:"varint,2,opt,name=current_timestamp,json=currentTimestamp,proto3" json:"current_timestamp,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the running core instance.

func (*CoreInfoResponse) Descriptor deprecated

func (*CoreInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use CoreInfoResponse.ProtoReflect.Descriptor instead.

func (*CoreInfoResponse) GetCurrentTimestamp added in v0.4.0

func (x *CoreInfoResponse) GetCurrentTimestamp() uint64

func (*CoreInfoResponse) GetStartupTimestamp

func (x *CoreInfoResponse) GetStartupTimestamp() uint64

func (*CoreInfoResponse) ProtoMessage

func (*CoreInfoResponse) ProtoMessage()

func (*CoreInfoResponse) ProtoReflect

func (x *CoreInfoResponse) ProtoReflect() protoreflect.Message

func (*CoreInfoResponse) Reset

func (x *CoreInfoResponse) Reset()

func (*CoreInfoResponse) String

func (x *CoreInfoResponse) String() string

type Event

type Event struct {

	// Types that are assignable to Inner:
	//	*Event_Message
	//	*Event_PrivateMessage
	//	*Event_Mention
	//	*Event_Command
	//	*Event_Action
	//	*Event_PrivateAction
	//	*Event_SendMessage
	//	*Event_SendPrivateMessage
	//	*Event_PerformAction
	//	*Event_PerformPrivateAction
	Inner isEvent_Inner     `protobuf_oneof:"inner"`
	Tags  map[string]string `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetAction

func (x *Event) GetAction() *ActionEvent

func (*Event) GetCommand

func (x *Event) GetCommand() *CommandEvent

func (*Event) GetInner

func (m *Event) GetInner() isEvent_Inner

func (*Event) GetMention

func (x *Event) GetMention() *MentionEvent

func (*Event) GetMessage

func (x *Event) GetMessage() *MessageEvent

func (*Event) GetPerformAction added in v0.3.0

func (x *Event) GetPerformAction() *PerformActionEvent

func (*Event) GetPerformPrivateAction added in v0.3.0

func (x *Event) GetPerformPrivateAction() *PerformPrivateActionEvent

func (*Event) GetPrivateAction

func (x *Event) GetPrivateAction() *PrivateActionEvent

func (*Event) GetPrivateMessage

func (x *Event) GetPrivateMessage() *PrivateMessageEvent

func (*Event) GetSendMessage added in v0.3.0

func (x *Event) GetSendMessage() *SendMessageEvent

func (*Event) GetSendPrivateMessage added in v0.3.0

func (x *Event) GetSendPrivateMessage() *SendPrivateMessageEvent

func (*Event) GetTags added in v0.4.0

func (x *Event) GetTags() map[string]string

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Event_Action

type Event_Action struct {
	Action *ActionEvent `protobuf:"bytes,5,opt,name=action,proto3,oneof"`
}

type Event_Command

type Event_Command struct {
	Command *CommandEvent `protobuf:"bytes,4,opt,name=command,proto3,oneof"`
}

type Event_Mention

type Event_Mention struct {
	Mention *MentionEvent `protobuf:"bytes,3,opt,name=mention,proto3,oneof"`
}

type Event_Message

type Event_Message struct {
	// Events sent by chat backends.
	Message *MessageEvent `protobuf:"bytes,1,opt,name=message,proto3,oneof"`
}

type Event_PerformAction added in v0.3.0

type Event_PerformAction struct {
	PerformAction *PerformActionEvent `protobuf:"bytes,9,opt,name=perform_action,json=performAction,proto3,oneof"`
}

type Event_PerformPrivateAction added in v0.3.0

type Event_PerformPrivateAction struct {
	PerformPrivateAction *PerformPrivateActionEvent `protobuf:"bytes,10,opt,name=perform_private_action,json=performPrivateAction,proto3,oneof"`
}

type Event_PrivateAction

type Event_PrivateAction struct {
	PrivateAction *PrivateActionEvent `protobuf:"bytes,6,opt,name=private_action,json=privateAction,proto3,oneof"`
}

type Event_PrivateMessage

type Event_PrivateMessage struct {
	PrivateMessage *PrivateMessageEvent `protobuf:"bytes,2,opt,name=private_message,json=privateMessage,proto3,oneof"`
}

type Event_SendMessage added in v0.3.0

type Event_SendMessage struct {
	// Events sent by plugins and other clients. Generally, these are only
	// needed for special cases.
	SendMessage *SendMessageEvent `protobuf:"bytes,7,opt,name=send_message,json=sendMessage,proto3,oneof"`
}

type Event_SendPrivateMessage added in v0.3.0

type Event_SendPrivateMessage struct {
	SendPrivateMessage *SendPrivateMessageEvent `protobuf:"bytes,8,opt,name=send_private_message,json=sendPrivateMessage,proto3,oneof"`
}

type FailedChatEvent

type FailedChatEvent struct {
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*FailedChatEvent) Descriptor deprecated

func (*FailedChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use FailedChatEvent.ProtoReflect.Descriptor instead.

func (*FailedChatEvent) GetReason

func (x *FailedChatEvent) GetReason() string

func (*FailedChatEvent) ProtoMessage

func (*FailedChatEvent) ProtoMessage()

func (*FailedChatEvent) ProtoReflect

func (x *FailedChatEvent) ProtoReflect() protoreflect.Message

func (*FailedChatEvent) Reset

func (x *FailedChatEvent) Reset()

func (*FailedChatEvent) String

func (x *FailedChatEvent) String() string

type HelloChatEvent

type HelloChatEvent struct {
	BackendInfo *Backend `protobuf:"bytes,1,opt,name=backend_info,json=backendInfo,proto3" json:"backend_info,omitempty"`
	// contains filtered or unexported fields
}

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.

Note that all IDs sent by a chat backend will be automatically namespaced by core based on the backend. As an example, a backend of type "foo" and an ID of "bar" may show up as something like "foo.bar" to plugins.

func (*HelloChatEvent) Descriptor deprecated

func (*HelloChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use HelloChatEvent.ProtoReflect.Descriptor instead.

func (*HelloChatEvent) GetBackendInfo

func (x *HelloChatEvent) GetBackendInfo() *Backend

func (*HelloChatEvent) ProtoMessage

func (*HelloChatEvent) ProtoMessage()

func (*HelloChatEvent) ProtoReflect

func (x *HelloChatEvent) ProtoReflect() protoreflect.Message

func (*HelloChatEvent) Reset

func (x *HelloChatEvent) Reset()

func (*HelloChatEvent) String

func (x *HelloChatEvent) String() string

type JoinChannelChatEvent

type JoinChannelChatEvent struct {
	ChannelId   string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	Topic       string `protobuf:"bytes,3,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*JoinChannelChatEvent) Descriptor deprecated

func (*JoinChannelChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use JoinChannelChatEvent.ProtoReflect.Descriptor instead.

func (*JoinChannelChatEvent) GetChannelId

func (x *JoinChannelChatEvent) GetChannelId() string

func (*JoinChannelChatEvent) GetDisplayName

func (x *JoinChannelChatEvent) GetDisplayName() string

func (*JoinChannelChatEvent) GetTopic

func (x *JoinChannelChatEvent) GetTopic() string

func (*JoinChannelChatEvent) ProtoMessage

func (*JoinChannelChatEvent) ProtoMessage()

func (*JoinChannelChatEvent) ProtoReflect

func (x *JoinChannelChatEvent) ProtoReflect() protoreflect.Message

func (*JoinChannelChatEvent) Reset

func (x *JoinChannelChatEvent) Reset()

func (*JoinChannelChatEvent) String

func (x *JoinChannelChatEvent) String() string

type JoinChannelChatRequest

type JoinChannelChatRequest struct {
	ChannelName string            `protobuf:"bytes,1,opt,name=channel_name,json=channelName,proto3" json:"channel_name,omitempty"`
	Tags        map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

JoinChannelChatRequest requests for the bot to join a channel with the given name. Either JoinChannelEvent or FailedChatEvent SHOULD be returned in response if possible.

func (*JoinChannelChatRequest) Descriptor deprecated

func (*JoinChannelChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use JoinChannelChatRequest.ProtoReflect.Descriptor instead.

func (*JoinChannelChatRequest) GetChannelName

func (x *JoinChannelChatRequest) GetChannelName() string

func (*JoinChannelChatRequest) GetTags added in v0.4.0

func (x *JoinChannelChatRequest) GetTags() map[string]string

func (*JoinChannelChatRequest) ProtoMessage

func (*JoinChannelChatRequest) ProtoMessage()

func (*JoinChannelChatRequest) ProtoReflect

func (x *JoinChannelChatRequest) ProtoReflect() protoreflect.Message

func (*JoinChannelChatRequest) Reset

func (x *JoinChannelChatRequest) Reset()

func (*JoinChannelChatRequest) String

func (x *JoinChannelChatRequest) String() string

type JoinChannelRequest

type JoinChannelRequest struct {
	BackendId string `protobuf:"bytes,1,opt,name=backend_id,json=backendId,proto3" json:"backend_id,omitempty"`
	// NOTE: this channel_name is the only place name is used for an identifier -
	// all other times channels will be referred to by ID.
	ChannelName string            `protobuf:"bytes,2,opt,name=channel_name,json=channelName,proto3" json:"channel_name,omitempty"`
	Tags        map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request to join a channel.

func (*JoinChannelRequest) Descriptor deprecated

func (*JoinChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use JoinChannelRequest.ProtoReflect.Descriptor instead.

func (*JoinChannelRequest) GetBackendId

func (x *JoinChannelRequest) GetBackendId() string

func (*JoinChannelRequest) GetChannelName

func (x *JoinChannelRequest) GetChannelName() string

func (*JoinChannelRequest) GetTags added in v0.4.0

func (x *JoinChannelRequest) GetTags() map[string]string

func (*JoinChannelRequest) ProtoMessage

func (*JoinChannelRequest) ProtoMessage()

func (*JoinChannelRequest) ProtoReflect

func (x *JoinChannelRequest) ProtoReflect() protoreflect.Message

func (*JoinChannelRequest) Reset

func (x *JoinChannelRequest) Reset()

func (*JoinChannelRequest) String

func (x *JoinChannelRequest) String() string

type JoinChannelResponse

type JoinChannelResponse struct {
	// contains filtered or unexported fields
}

func (*JoinChannelResponse) Descriptor deprecated

func (*JoinChannelResponse) Descriptor() ([]byte, []int)

Deprecated: Use JoinChannelResponse.ProtoReflect.Descriptor instead.

func (*JoinChannelResponse) ProtoMessage

func (*JoinChannelResponse) ProtoMessage()

func (*JoinChannelResponse) ProtoReflect

func (x *JoinChannelResponse) ProtoReflect() protoreflect.Message

func (*JoinChannelResponse) Reset

func (x *JoinChannelResponse) Reset()

func (*JoinChannelResponse) String

func (x *JoinChannelResponse) String() string

type LeaveChannelChatEvent

type LeaveChannelChatEvent struct {
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	// contains filtered or unexported fields
}

LeaveChannelEvent will be sent when a user leaves a channel.

func (*LeaveChannelChatEvent) Descriptor deprecated

func (*LeaveChannelChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use LeaveChannelChatEvent.ProtoReflect.Descriptor instead.

func (*LeaveChannelChatEvent) GetChannelId

func (x *LeaveChannelChatEvent) GetChannelId() string

func (*LeaveChannelChatEvent) ProtoMessage

func (*LeaveChannelChatEvent) ProtoMessage()

func (*LeaveChannelChatEvent) ProtoReflect

func (x *LeaveChannelChatEvent) ProtoReflect() protoreflect.Message

func (*LeaveChannelChatEvent) Reset

func (x *LeaveChannelChatEvent) Reset()

func (*LeaveChannelChatEvent) String

func (x *LeaveChannelChatEvent) String() string

type LeaveChannelChatRequest

type LeaveChannelChatRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

LeaveChannelChatRequest requests for the bot to leave the channel with the given ID. Either LeaveChannelEvent or FailedChatEvent SHOULD be returned in response if possible.

func (*LeaveChannelChatRequest) Descriptor deprecated

func (*LeaveChannelChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaveChannelChatRequest.ProtoReflect.Descriptor instead.

func (*LeaveChannelChatRequest) GetChannelId

func (x *LeaveChannelChatRequest) GetChannelId() string

func (*LeaveChannelChatRequest) GetTags added in v0.4.0

func (x *LeaveChannelChatRequest) GetTags() map[string]string

func (*LeaveChannelChatRequest) ProtoMessage

func (*LeaveChannelChatRequest) ProtoMessage()

func (*LeaveChannelChatRequest) ProtoReflect

func (x *LeaveChannelChatRequest) ProtoReflect() protoreflect.Message

func (*LeaveChannelChatRequest) Reset

func (x *LeaveChannelChatRequest) Reset()

func (*LeaveChannelChatRequest) String

func (x *LeaveChannelChatRequest) String() string

type LeaveChannelRequest

type LeaveChannelRequest struct {
	ChannelId   string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	ExitMessage string            `protobuf:"bytes,2,opt,name=exit_message,json=exitMessage,proto3" json:"exit_message,omitempty"`
	Tags        map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request to leave a channel.

func (*LeaveChannelRequest) Descriptor deprecated

func (*LeaveChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaveChannelRequest.ProtoReflect.Descriptor instead.

func (*LeaveChannelRequest) GetChannelId

func (x *LeaveChannelRequest) GetChannelId() string

func (*LeaveChannelRequest) GetExitMessage

func (x *LeaveChannelRequest) GetExitMessage() string

func (*LeaveChannelRequest) GetTags added in v0.4.0

func (x *LeaveChannelRequest) GetTags() map[string]string

func (*LeaveChannelRequest) ProtoMessage

func (*LeaveChannelRequest) ProtoMessage()

func (*LeaveChannelRequest) ProtoReflect

func (x *LeaveChannelRequest) ProtoReflect() protoreflect.Message

func (*LeaveChannelRequest) Reset

func (x *LeaveChannelRequest) Reset()

func (*LeaveChannelRequest) String

func (x *LeaveChannelRequest) String() string

type LeaveChannelResponse

type LeaveChannelResponse struct {
	// contains filtered or unexported fields
}

func (*LeaveChannelResponse) Descriptor deprecated

func (*LeaveChannelResponse) Descriptor() ([]byte, []int)

Deprecated: Use LeaveChannelResponse.ProtoReflect.Descriptor instead.

func (*LeaveChannelResponse) ProtoMessage

func (*LeaveChannelResponse) ProtoMessage()

func (*LeaveChannelResponse) ProtoReflect

func (x *LeaveChannelResponse) ProtoReflect() protoreflect.Message

func (*LeaveChannelResponse) Reset

func (x *LeaveChannelResponse) Reset()

func (*LeaveChannelResponse) String

func (x *LeaveChannelResponse) String() string

type ListBackendsRequest

type ListBackendsRequest struct {
	// contains filtered or unexported fields
}

Request to list all connected backends.

func (*ListBackendsRequest) Descriptor deprecated

func (*ListBackendsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListBackendsRequest.ProtoReflect.Descriptor instead.

func (*ListBackendsRequest) ProtoMessage

func (*ListBackendsRequest) ProtoMessage()

func (*ListBackendsRequest) ProtoReflect

func (x *ListBackendsRequest) ProtoReflect() protoreflect.Message

func (*ListBackendsRequest) Reset

func (x *ListBackendsRequest) Reset()

func (*ListBackendsRequest) String

func (x *ListBackendsRequest) String() string

type ListBackendsResponse

type ListBackendsResponse struct {
	Backends []*Backend `protobuf:"bytes,1,rep,name=backends,proto3" json:"backends,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBackendsResponse) Descriptor deprecated

func (*ListBackendsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListBackendsResponse.ProtoReflect.Descriptor instead.

func (*ListBackendsResponse) GetBackends

func (x *ListBackendsResponse) GetBackends() []*Backend

func (*ListBackendsResponse) ProtoMessage

func (*ListBackendsResponse) ProtoMessage()

func (*ListBackendsResponse) ProtoReflect

func (x *ListBackendsResponse) ProtoReflect() protoreflect.Message

func (*ListBackendsResponse) Reset

func (x *ListBackendsResponse) Reset()

func (*ListBackendsResponse) String

func (x *ListBackendsResponse) String() string

type ListChannelsRequest

type ListChannelsRequest struct {
	BackendId string `protobuf:"bytes,1,opt,name=backend_id,json=backendId,proto3" json:"backend_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListChannelsRequest) Descriptor deprecated

func (*ListChannelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListChannelsRequest.ProtoReflect.Descriptor instead.

func (*ListChannelsRequest) GetBackendId

func (x *ListChannelsRequest) GetBackendId() string

func (*ListChannelsRequest) ProtoMessage

func (*ListChannelsRequest) ProtoMessage()

func (*ListChannelsRequest) ProtoReflect

func (x *ListChannelsRequest) ProtoReflect() protoreflect.Message

func (*ListChannelsRequest) Reset

func (x *ListChannelsRequest) Reset()

func (*ListChannelsRequest) String

func (x *ListChannelsRequest) String() string

type ListChannelsResponse

type ListChannelsResponse struct {
	Channels []*Channel `protobuf:"bytes,1,rep,name=channels,proto3" json:"channels,omitempty"`
	// contains filtered or unexported fields
}

func (*ListChannelsResponse) Descriptor deprecated

func (*ListChannelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListChannelsResponse.ProtoReflect.Descriptor instead.

func (*ListChannelsResponse) GetChannels

func (x *ListChannelsResponse) GetChannels() []*Channel

func (*ListChannelsResponse) ProtoMessage

func (*ListChannelsResponse) ProtoMessage()

func (*ListChannelsResponse) ProtoReflect

func (x *ListChannelsResponse) ProtoReflect() protoreflect.Message

func (*ListChannelsResponse) Reset

func (x *ListChannelsResponse) Reset()

func (*ListChannelsResponse) String

func (x *ListChannelsResponse) String() string

type MentionEvent

type MentionEvent struct {
	Source *ChannelSource `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Text   string         `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

MentionEvent will be sent when a user mentions the chat backend's user at the start of a message in a channel. Note that this may eventually go away when a more general message format is developed.

func (*MentionEvent) Descriptor deprecated

func (*MentionEvent) Descriptor() ([]byte, []int)

Deprecated: Use MentionEvent.ProtoReflect.Descriptor instead.

func (*MentionEvent) GetSource

func (x *MentionEvent) GetSource() *ChannelSource

func (*MentionEvent) GetText

func (x *MentionEvent) GetText() string

func (*MentionEvent) ProtoMessage

func (*MentionEvent) ProtoMessage()

func (*MentionEvent) ProtoReflect

func (x *MentionEvent) ProtoReflect() protoreflect.Message

func (*MentionEvent) Reset

func (x *MentionEvent) Reset()

func (*MentionEvent) String

func (x *MentionEvent) String() string

type MessageEvent

type MessageEvent struct {
	Source *ChannelSource `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Text   string         `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

MessageEvent will be sent when a user sends a message to a channel.

func (*MessageEvent) Descriptor deprecated

func (*MessageEvent) Descriptor() ([]byte, []int)

Deprecated: Use MessageEvent.ProtoReflect.Descriptor instead.

func (*MessageEvent) GetSource

func (x *MessageEvent) GetSource() *ChannelSource

func (*MessageEvent) GetText

func (x *MessageEvent) GetText() string

func (*MessageEvent) ProtoMessage

func (*MessageEvent) ProtoMessage()

func (*MessageEvent) ProtoReflect

func (x *MessageEvent) ProtoReflect() protoreflect.Message

func (*MessageEvent) Reset

func (x *MessageEvent) Reset()

func (*MessageEvent) String

func (x *MessageEvent) String() string

type MetadataChatEvent added in v0.3.0

type MetadataChatEvent struct {
	Values map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

MetadataChatEvent will be sent in response to a MetadataChatRequest. It is not sent directly without a corresponding request from seabird-core.

func (*MetadataChatEvent) Descriptor deprecated added in v0.3.0

func (*MetadataChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use MetadataChatEvent.ProtoReflect.Descriptor instead.

func (*MetadataChatEvent) GetValues added in v0.3.0

func (x *MetadataChatEvent) GetValues() map[string]string

func (*MetadataChatEvent) ProtoMessage added in v0.3.0

func (*MetadataChatEvent) ProtoMessage()

func (*MetadataChatEvent) ProtoReflect added in v0.3.0

func (x *MetadataChatEvent) ProtoReflect() protoreflect.Message

func (*MetadataChatEvent) Reset added in v0.3.0

func (x *MetadataChatEvent) Reset()

func (*MetadataChatEvent) String added in v0.3.0

func (x *MetadataChatEvent) String() string

type MetadataChatRequest added in v0.3.0

type MetadataChatRequest struct {
	// contains filtered or unexported fields
}

MetadataChatRequest requests metadata about the given backend. seabird-core expects the backend to respond with a MetadataChatEvent object.

func (*MetadataChatRequest) Descriptor deprecated added in v0.3.0

func (*MetadataChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use MetadataChatRequest.ProtoReflect.Descriptor instead.

func (*MetadataChatRequest) ProtoMessage added in v0.3.0

func (*MetadataChatRequest) ProtoMessage()

func (*MetadataChatRequest) ProtoReflect added in v0.3.0

func (x *MetadataChatRequest) ProtoReflect() protoreflect.Message

func (*MetadataChatRequest) Reset added in v0.3.0

func (x *MetadataChatRequest) Reset()

func (*MetadataChatRequest) String added in v0.3.0

func (x *MetadataChatRequest) String() string

type PerformActionChatRequest

type PerformActionChatRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*PerformActionChatRequest) Descriptor deprecated

func (*PerformActionChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use PerformActionChatRequest.ProtoReflect.Descriptor instead.

func (*PerformActionChatRequest) GetChannelId

func (x *PerformActionChatRequest) GetChannelId() string

func (*PerformActionChatRequest) GetTags added in v0.4.0

func (x *PerformActionChatRequest) GetTags() map[string]string

func (*PerformActionChatRequest) GetText

func (x *PerformActionChatRequest) GetText() string

func (*PerformActionChatRequest) ProtoMessage

func (*PerformActionChatRequest) ProtoMessage()

func (*PerformActionChatRequest) ProtoReflect

func (x *PerformActionChatRequest) ProtoReflect() protoreflect.Message

func (*PerformActionChatRequest) Reset

func (x *PerformActionChatRequest) Reset()

func (*PerformActionChatRequest) String

func (x *PerformActionChatRequest) String() string

type PerformActionEvent added in v0.3.0

type PerformActionEvent struct {
	Sender    string `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender,omitempty"`
	ChannelId string `protobuf:"bytes,2,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*PerformActionEvent) Descriptor deprecated added in v0.3.0

func (*PerformActionEvent) Descriptor() ([]byte, []int)

Deprecated: Use PerformActionEvent.ProtoReflect.Descriptor instead.

func (*PerformActionEvent) GetChannelId added in v0.4.0

func (x *PerformActionEvent) GetChannelId() string

func (*PerformActionEvent) GetSender added in v0.3.0

func (x *PerformActionEvent) GetSender() string

func (*PerformActionEvent) GetText added in v0.4.0

func (x *PerformActionEvent) GetText() string

func (*PerformActionEvent) ProtoMessage added in v0.3.0

func (*PerformActionEvent) ProtoMessage()

func (*PerformActionEvent) ProtoReflect added in v0.3.0

func (x *PerformActionEvent) ProtoReflect() protoreflect.Message

func (*PerformActionEvent) Reset added in v0.3.0

func (x *PerformActionEvent) Reset()

func (*PerformActionEvent) String added in v0.3.0

func (x *PerformActionEvent) String() string

type PerformActionRequest

type PerformActionRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Perform an action in a given channel.

func (*PerformActionRequest) Descriptor deprecated

func (*PerformActionRequest) Descriptor() ([]byte, []int)

Deprecated: Use PerformActionRequest.ProtoReflect.Descriptor instead.

func (*PerformActionRequest) GetChannelId

func (x *PerformActionRequest) GetChannelId() string

func (*PerformActionRequest) GetTags added in v0.4.0

func (x *PerformActionRequest) GetTags() map[string]string

func (*PerformActionRequest) GetText

func (x *PerformActionRequest) GetText() string

func (*PerformActionRequest) ProtoMessage

func (*PerformActionRequest) ProtoMessage()

func (*PerformActionRequest) ProtoReflect

func (x *PerformActionRequest) ProtoReflect() protoreflect.Message

func (*PerformActionRequest) Reset

func (x *PerformActionRequest) Reset()

func (*PerformActionRequest) String

func (x *PerformActionRequest) String() string

type PerformActionResponse

type PerformActionResponse struct {
	// contains filtered or unexported fields
}

func (*PerformActionResponse) Descriptor deprecated

func (*PerformActionResponse) Descriptor() ([]byte, []int)

Deprecated: Use PerformActionResponse.ProtoReflect.Descriptor instead.

func (*PerformActionResponse) ProtoMessage

func (*PerformActionResponse) ProtoMessage()

func (*PerformActionResponse) ProtoReflect

func (x *PerformActionResponse) ProtoReflect() protoreflect.Message

func (*PerformActionResponse) Reset

func (x *PerformActionResponse) Reset()

func (*PerformActionResponse) String

func (x *PerformActionResponse) String() string

type PerformPrivateActionChatRequest

type PerformPrivateActionChatRequest struct {
	UserId string            `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags   map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*PerformPrivateActionChatRequest) Descriptor deprecated

func (*PerformPrivateActionChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use PerformPrivateActionChatRequest.ProtoReflect.Descriptor instead.

func (*PerformPrivateActionChatRequest) GetTags added in v0.4.0

func (*PerformPrivateActionChatRequest) GetText

func (*PerformPrivateActionChatRequest) GetUserId

func (x *PerformPrivateActionChatRequest) GetUserId() string

func (*PerformPrivateActionChatRequest) ProtoMessage

func (*PerformPrivateActionChatRequest) ProtoMessage()

func (*PerformPrivateActionChatRequest) ProtoReflect

func (*PerformPrivateActionChatRequest) Reset

func (*PerformPrivateActionChatRequest) String

type PerformPrivateActionEvent added in v0.3.0

type PerformPrivateActionEvent struct {
	Sender string `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender,omitempty"`
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*PerformPrivateActionEvent) Descriptor deprecated added in v0.3.0

func (*PerformPrivateActionEvent) Descriptor() ([]byte, []int)

Deprecated: Use PerformPrivateActionEvent.ProtoReflect.Descriptor instead.

func (*PerformPrivateActionEvent) GetSender added in v0.3.0

func (x *PerformPrivateActionEvent) GetSender() string

func (*PerformPrivateActionEvent) GetText added in v0.4.0

func (x *PerformPrivateActionEvent) GetText() string

func (*PerformPrivateActionEvent) GetUserId added in v0.4.0

func (x *PerformPrivateActionEvent) GetUserId() string

func (*PerformPrivateActionEvent) ProtoMessage added in v0.3.0

func (*PerformPrivateActionEvent) ProtoMessage()

func (*PerformPrivateActionEvent) ProtoReflect added in v0.3.0

func (*PerformPrivateActionEvent) Reset added in v0.3.0

func (x *PerformPrivateActionEvent) Reset()

func (*PerformPrivateActionEvent) String added in v0.3.0

func (x *PerformPrivateActionEvent) String() string

type PerformPrivateActionRequest

type PerformPrivateActionRequest struct {
	UserId string            `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags   map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Perform an action in a private message.

func (*PerformPrivateActionRequest) Descriptor deprecated

func (*PerformPrivateActionRequest) Descriptor() ([]byte, []int)

Deprecated: Use PerformPrivateActionRequest.ProtoReflect.Descriptor instead.

func (*PerformPrivateActionRequest) GetTags added in v0.4.0

func (x *PerformPrivateActionRequest) GetTags() map[string]string

func (*PerformPrivateActionRequest) GetText

func (x *PerformPrivateActionRequest) GetText() string

func (*PerformPrivateActionRequest) GetUserId

func (x *PerformPrivateActionRequest) GetUserId() string

func (*PerformPrivateActionRequest) ProtoMessage

func (*PerformPrivateActionRequest) ProtoMessage()

func (*PerformPrivateActionRequest) ProtoReflect

func (*PerformPrivateActionRequest) Reset

func (x *PerformPrivateActionRequest) Reset()

func (*PerformPrivateActionRequest) String

func (x *PerformPrivateActionRequest) String() string

type PerformPrivateActionResponse

type PerformPrivateActionResponse struct {
	// contains filtered or unexported fields
}

func (*PerformPrivateActionResponse) Descriptor deprecated

func (*PerformPrivateActionResponse) Descriptor() ([]byte, []int)

Deprecated: Use PerformPrivateActionResponse.ProtoReflect.Descriptor instead.

func (*PerformPrivateActionResponse) ProtoMessage

func (*PerformPrivateActionResponse) ProtoMessage()

func (*PerformPrivateActionResponse) ProtoReflect

func (*PerformPrivateActionResponse) Reset

func (x *PerformPrivateActionResponse) Reset()

func (*PerformPrivateActionResponse) String

type PrivateActionEvent

type PrivateActionEvent struct {
	Source *User  `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Text   string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

PrivateActionEvent will be sent when a user takes an action in a private message. This is often triggered with /me.

func (*PrivateActionEvent) Descriptor deprecated

func (*PrivateActionEvent) Descriptor() ([]byte, []int)

Deprecated: Use PrivateActionEvent.ProtoReflect.Descriptor instead.

func (*PrivateActionEvent) GetSource

func (x *PrivateActionEvent) GetSource() *User

func (*PrivateActionEvent) GetText

func (x *PrivateActionEvent) GetText() string

func (*PrivateActionEvent) ProtoMessage

func (*PrivateActionEvent) ProtoMessage()

func (*PrivateActionEvent) ProtoReflect

func (x *PrivateActionEvent) ProtoReflect() protoreflect.Message

func (*PrivateActionEvent) Reset

func (x *PrivateActionEvent) Reset()

func (*PrivateActionEvent) String

func (x *PrivateActionEvent) String() string

type PrivateMessageEvent

type PrivateMessageEvent struct {
	Source *User  `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Text   string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

PrivateMessageEvent will be sent when a user sends a message directly to the chat backend.

func (*PrivateMessageEvent) Descriptor deprecated

func (*PrivateMessageEvent) Descriptor() ([]byte, []int)

Deprecated: Use PrivateMessageEvent.ProtoReflect.Descriptor instead.

func (*PrivateMessageEvent) GetSource

func (x *PrivateMessageEvent) GetSource() *User

func (*PrivateMessageEvent) GetText

func (x *PrivateMessageEvent) GetText() string

func (*PrivateMessageEvent) ProtoMessage

func (*PrivateMessageEvent) ProtoMessage()

func (*PrivateMessageEvent) ProtoReflect

func (x *PrivateMessageEvent) ProtoReflect() protoreflect.Message

func (*PrivateMessageEvent) Reset

func (x *PrivateMessageEvent) Reset()

func (*PrivateMessageEvent) String

func (x *PrivateMessageEvent) String() string

type SeabirdClient

type SeabirdClient interface {
	StreamEvents(ctx context.Context, in *StreamEventsRequest, opts ...grpc.CallOption) (Seabird_StreamEventsClient, error)
	// Chat actions
	PerformAction(ctx context.Context, in *PerformActionRequest, opts ...grpc.CallOption) (*PerformActionResponse, error)
	PerformPrivateAction(ctx context.Context, in *PerformPrivateActionRequest, opts ...grpc.CallOption) (*PerformPrivateActionResponse, error)
	SendMessage(ctx context.Context, in *SendMessageRequest, opts ...grpc.CallOption) (*SendMessageResponse, error)
	SendPrivateMessage(ctx context.Context, in *SendPrivateMessageRequest, opts ...grpc.CallOption) (*SendPrivateMessageResponse, error)
	JoinChannel(ctx context.Context, in *JoinChannelRequest, opts ...grpc.CallOption) (*JoinChannelResponse, error)
	LeaveChannel(ctx context.Context, in *LeaveChannelRequest, opts ...grpc.CallOption) (*LeaveChannelResponse, error)
	UpdateChannelInfo(ctx context.Context, in *UpdateChannelInfoRequest, opts ...grpc.CallOption) (*UpdateChannelInfoResponse, error)
	// Chat backend introspection
	ListBackends(ctx context.Context, in *ListBackendsRequest, opts ...grpc.CallOption) (*ListBackendsResponse, error)
	GetBackendInfo(ctx context.Context, in *BackendInfoRequest, opts ...grpc.CallOption) (*BackendInfoResponse, error)
	// Chat connection introspection
	ListChannels(ctx context.Context, in *ListChannelsRequest, opts ...grpc.CallOption) (*ListChannelsResponse, error)
	GetChannelInfo(ctx context.Context, in *ChannelInfoRequest, opts ...grpc.CallOption) (*ChannelInfoResponse, error)
	// Seabird introspection
	GetCoreInfo(ctx context.Context, in *CoreInfoRequest, opts ...grpc.CallOption) (*CoreInfoResponse, error)
	RegisteredCommands(ctx context.Context, in *CommandsRequest, opts ...grpc.CallOption) (*CommandsResponse, error)
}

SeabirdClient is the client API for Seabird service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSeabirdClient

func NewSeabirdClient(cc grpc.ClientConnInterface) SeabirdClient

type SeabirdServer

type SeabirdServer interface {
	StreamEvents(*StreamEventsRequest, Seabird_StreamEventsServer) error
	// Chat actions
	PerformAction(context.Context, *PerformActionRequest) (*PerformActionResponse, error)
	PerformPrivateAction(context.Context, *PerformPrivateActionRequest) (*PerformPrivateActionResponse, error)
	SendMessage(context.Context, *SendMessageRequest) (*SendMessageResponse, error)
	SendPrivateMessage(context.Context, *SendPrivateMessageRequest) (*SendPrivateMessageResponse, error)
	JoinChannel(context.Context, *JoinChannelRequest) (*JoinChannelResponse, error)
	LeaveChannel(context.Context, *LeaveChannelRequest) (*LeaveChannelResponse, error)
	UpdateChannelInfo(context.Context, *UpdateChannelInfoRequest) (*UpdateChannelInfoResponse, error)
	// Chat backend introspection
	ListBackends(context.Context, *ListBackendsRequest) (*ListBackendsResponse, error)
	GetBackendInfo(context.Context, *BackendInfoRequest) (*BackendInfoResponse, error)
	// Chat connection introspection
	ListChannels(context.Context, *ListChannelsRequest) (*ListChannelsResponse, error)
	GetChannelInfo(context.Context, *ChannelInfoRequest) (*ChannelInfoResponse, error)
	// Seabird introspection
	GetCoreInfo(context.Context, *CoreInfoRequest) (*CoreInfoResponse, error)
	RegisteredCommands(context.Context, *CommandsRequest) (*CommandsResponse, error)
	// contains filtered or unexported methods
}

SeabirdServer is the server API for Seabird service. All implementations must embed UnimplementedSeabirdServer for forward compatibility

type Seabird_StreamEventsClient

type Seabird_StreamEventsClient interface {
	Recv() (*Event, error)
	grpc.ClientStream
}

type Seabird_StreamEventsServer

type Seabird_StreamEventsServer interface {
	Send(*Event) error
	grpc.ServerStream
}

type SendMessageChatRequest

type SendMessageChatRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*SendMessageChatRequest) Descriptor deprecated

func (*SendMessageChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendMessageChatRequest.ProtoReflect.Descriptor instead.

func (*SendMessageChatRequest) GetChannelId

func (x *SendMessageChatRequest) GetChannelId() string

func (*SendMessageChatRequest) GetTags added in v0.4.0

func (x *SendMessageChatRequest) GetTags() map[string]string

func (*SendMessageChatRequest) GetText

func (x *SendMessageChatRequest) GetText() string

func (*SendMessageChatRequest) ProtoMessage

func (*SendMessageChatRequest) ProtoMessage()

func (*SendMessageChatRequest) ProtoReflect

func (x *SendMessageChatRequest) ProtoReflect() protoreflect.Message

func (*SendMessageChatRequest) Reset

func (x *SendMessageChatRequest) Reset()

func (*SendMessageChatRequest) String

func (x *SendMessageChatRequest) String() string

type SendMessageEvent added in v0.3.0

type SendMessageEvent struct {
	Sender    string `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender,omitempty"`
	ChannelId string `protobuf:"bytes,2,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SendMessageEvent) Descriptor deprecated added in v0.3.0

func (*SendMessageEvent) Descriptor() ([]byte, []int)

Deprecated: Use SendMessageEvent.ProtoReflect.Descriptor instead.

func (*SendMessageEvent) GetChannelId added in v0.4.0

func (x *SendMessageEvent) GetChannelId() string

func (*SendMessageEvent) GetSender added in v0.3.0

func (x *SendMessageEvent) GetSender() string

func (*SendMessageEvent) GetText added in v0.4.0

func (x *SendMessageEvent) GetText() string

func (*SendMessageEvent) ProtoMessage added in v0.3.0

func (*SendMessageEvent) ProtoMessage()

func (*SendMessageEvent) ProtoReflect added in v0.3.0

func (x *SendMessageEvent) ProtoReflect() protoreflect.Message

func (*SendMessageEvent) Reset added in v0.3.0

func (x *SendMessageEvent) Reset()

func (*SendMessageEvent) String added in v0.3.0

func (x *SendMessageEvent) String() string

type SendMessageRequest

type SendMessageRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Text      string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Send a message to a given a channel.

func (*SendMessageRequest) Descriptor deprecated

func (*SendMessageRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendMessageRequest.ProtoReflect.Descriptor instead.

func (*SendMessageRequest) GetChannelId

func (x *SendMessageRequest) GetChannelId() string

func (*SendMessageRequest) GetTags added in v0.4.0

func (x *SendMessageRequest) GetTags() map[string]string

func (*SendMessageRequest) GetText

func (x *SendMessageRequest) GetText() string

func (*SendMessageRequest) ProtoMessage

func (*SendMessageRequest) ProtoMessage()

func (*SendMessageRequest) ProtoReflect

func (x *SendMessageRequest) ProtoReflect() protoreflect.Message

func (*SendMessageRequest) Reset

func (x *SendMessageRequest) Reset()

func (*SendMessageRequest) String

func (x *SendMessageRequest) String() string

type SendMessageResponse

type SendMessageResponse struct {
	// contains filtered or unexported fields
}

func (*SendMessageResponse) Descriptor deprecated

func (*SendMessageResponse) Descriptor() ([]byte, []int)

Deprecated: Use SendMessageResponse.ProtoReflect.Descriptor instead.

func (*SendMessageResponse) ProtoMessage

func (*SendMessageResponse) ProtoMessage()

func (*SendMessageResponse) ProtoReflect

func (x *SendMessageResponse) ProtoReflect() protoreflect.Message

func (*SendMessageResponse) Reset

func (x *SendMessageResponse) Reset()

func (*SendMessageResponse) String

func (x *SendMessageResponse) String() string

type SendPrivateMessageChatRequest

type SendPrivateMessageChatRequest struct {
	UserId string            `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags   map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*SendPrivateMessageChatRequest) Descriptor deprecated

func (*SendPrivateMessageChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendPrivateMessageChatRequest.ProtoReflect.Descriptor instead.

func (*SendPrivateMessageChatRequest) GetTags added in v0.4.0

func (x *SendPrivateMessageChatRequest) GetTags() map[string]string

func (*SendPrivateMessageChatRequest) GetText

func (*SendPrivateMessageChatRequest) GetUserId

func (x *SendPrivateMessageChatRequest) GetUserId() string

func (*SendPrivateMessageChatRequest) ProtoMessage

func (*SendPrivateMessageChatRequest) ProtoMessage()

func (*SendPrivateMessageChatRequest) ProtoReflect

func (*SendPrivateMessageChatRequest) Reset

func (x *SendPrivateMessageChatRequest) Reset()

func (*SendPrivateMessageChatRequest) String

type SendPrivateMessageEvent added in v0.3.0

type SendPrivateMessageEvent struct {
	Sender string `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender,omitempty"`
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SendPrivateMessageEvent) Descriptor deprecated added in v0.3.0

func (*SendPrivateMessageEvent) Descriptor() ([]byte, []int)

Deprecated: Use SendPrivateMessageEvent.ProtoReflect.Descriptor instead.

func (*SendPrivateMessageEvent) GetSender added in v0.3.0

func (x *SendPrivateMessageEvent) GetSender() string

func (*SendPrivateMessageEvent) GetText added in v0.4.0

func (x *SendPrivateMessageEvent) GetText() string

func (*SendPrivateMessageEvent) GetUserId added in v0.4.0

func (x *SendPrivateMessageEvent) GetUserId() string

func (*SendPrivateMessageEvent) ProtoMessage added in v0.3.0

func (*SendPrivateMessageEvent) ProtoMessage()

func (*SendPrivateMessageEvent) ProtoReflect added in v0.3.0

func (x *SendPrivateMessageEvent) ProtoReflect() protoreflect.Message

func (*SendPrivateMessageEvent) Reset added in v0.3.0

func (x *SendPrivateMessageEvent) Reset()

func (*SendPrivateMessageEvent) String added in v0.3.0

func (x *SendPrivateMessageEvent) String() string

type SendPrivateMessageRequest

type SendPrivateMessageRequest struct {
	UserId string            `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Text   string            `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Tags   map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Send a private message to a given user.

func (*SendPrivateMessageRequest) Descriptor deprecated

func (*SendPrivateMessageRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendPrivateMessageRequest.ProtoReflect.Descriptor instead.

func (*SendPrivateMessageRequest) GetTags added in v0.4.0

func (x *SendPrivateMessageRequest) GetTags() map[string]string

func (*SendPrivateMessageRequest) GetText

func (x *SendPrivateMessageRequest) GetText() string

func (*SendPrivateMessageRequest) GetUserId

func (x *SendPrivateMessageRequest) GetUserId() string

func (*SendPrivateMessageRequest) ProtoMessage

func (*SendPrivateMessageRequest) ProtoMessage()

func (*SendPrivateMessageRequest) ProtoReflect

func (*SendPrivateMessageRequest) Reset

func (x *SendPrivateMessageRequest) Reset()

func (*SendPrivateMessageRequest) String

func (x *SendPrivateMessageRequest) String() string

type SendPrivateMessageResponse

type SendPrivateMessageResponse struct {
	// contains filtered or unexported fields
}

func (*SendPrivateMessageResponse) Descriptor deprecated

func (*SendPrivateMessageResponse) Descriptor() ([]byte, []int)

Deprecated: Use SendPrivateMessageResponse.ProtoReflect.Descriptor instead.

func (*SendPrivateMessageResponse) ProtoMessage

func (*SendPrivateMessageResponse) ProtoMessage()

func (*SendPrivateMessageResponse) ProtoReflect

func (*SendPrivateMessageResponse) Reset

func (x *SendPrivateMessageResponse) Reset()

func (*SendPrivateMessageResponse) String

func (x *SendPrivateMessageResponse) String() string

type StreamEventsRequest

type StreamEventsRequest struct {

	// A registry of commands this plugin responds to. A plugin MUST register all
	// commands it responds to in order to receive those events. The
	// CommandMetadata's name MUST match the map key, or an error will be
	// returned.
	//
	// NOTE: help is a reserved command and cannot be registered by plugins.
	Commands map[string]*CommandMetadata `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StreamEventsRequest) Descriptor deprecated

func (*StreamEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use StreamEventsRequest.ProtoReflect.Descriptor instead.

func (*StreamEventsRequest) GetCommands

func (x *StreamEventsRequest) GetCommands() map[string]*CommandMetadata

func (*StreamEventsRequest) ProtoMessage

func (*StreamEventsRequest) ProtoMessage()

func (*StreamEventsRequest) ProtoReflect

func (x *StreamEventsRequest) ProtoReflect() protoreflect.Message

func (*StreamEventsRequest) Reset

func (x *StreamEventsRequest) Reset()

func (*StreamEventsRequest) String

func (x *StreamEventsRequest) String() string

type SuccessChatEvent

type SuccessChatEvent struct {
	// contains filtered or unexported fields
}

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.

func (*SuccessChatEvent) Descriptor deprecated

func (*SuccessChatEvent) Descriptor() ([]byte, []int)

Deprecated: Use SuccessChatEvent.ProtoReflect.Descriptor instead.

func (*SuccessChatEvent) ProtoMessage

func (*SuccessChatEvent) ProtoMessage()

func (*SuccessChatEvent) ProtoReflect

func (x *SuccessChatEvent) ProtoReflect() protoreflect.Message

func (*SuccessChatEvent) Reset

func (x *SuccessChatEvent) Reset()

func (*SuccessChatEvent) String

func (x *SuccessChatEvent) String() string

type UnimplementedChatIngestServer

type UnimplementedChatIngestServer struct {
}

UnimplementedChatIngestServer must be embedded to have forward compatible implementations.

func (UnimplementedChatIngestServer) IngestEvents

type UnimplementedSeabirdServer

type UnimplementedSeabirdServer struct {
}

UnimplementedSeabirdServer must be embedded to have forward compatible implementations.

func (UnimplementedSeabirdServer) GetBackendInfo

func (UnimplementedSeabirdServer) GetChannelInfo

func (UnimplementedSeabirdServer) GetCoreInfo

func (UnimplementedSeabirdServer) JoinChannel

func (UnimplementedSeabirdServer) LeaveChannel

func (UnimplementedSeabirdServer) ListBackends

func (UnimplementedSeabirdServer) ListChannels

func (UnimplementedSeabirdServer) PerformAction

func (UnimplementedSeabirdServer) RegisteredCommands added in v0.4.0

func (UnimplementedSeabirdServer) SendMessage

func (UnimplementedSeabirdServer) StreamEvents

type UnsafeChatIngestServer added in v0.3.0

type UnsafeChatIngestServer interface {
	// contains filtered or unexported methods
}

UnsafeChatIngestServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ChatIngestServer will result in compilation errors.

type UnsafeSeabirdServer added in v0.3.0

type UnsafeSeabirdServer interface {
	// contains filtered or unexported methods
}

UnsafeSeabirdServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SeabirdServer will result in compilation errors.

type UpdateChannelInfoChatRequest

type UpdateChannelInfoChatRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Topic     string            `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

UpdateChannelInfoChatRequest requests for a the channel to be updated with the given metadata. Either ChangeChannelEvent or FailedChatEvent SHOULD be returned in response if possible.

func (*UpdateChannelInfoChatRequest) Descriptor deprecated

func (*UpdateChannelInfoChatRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateChannelInfoChatRequest.ProtoReflect.Descriptor instead.

func (*UpdateChannelInfoChatRequest) GetChannelId

func (x *UpdateChannelInfoChatRequest) GetChannelId() string

func (*UpdateChannelInfoChatRequest) GetTags added in v0.4.0

func (x *UpdateChannelInfoChatRequest) GetTags() map[string]string

func (*UpdateChannelInfoChatRequest) GetTopic

func (x *UpdateChannelInfoChatRequest) GetTopic() string

func (*UpdateChannelInfoChatRequest) ProtoMessage

func (*UpdateChannelInfoChatRequest) ProtoMessage()

func (*UpdateChannelInfoChatRequest) ProtoReflect

func (*UpdateChannelInfoChatRequest) Reset

func (x *UpdateChannelInfoChatRequest) Reset()

func (*UpdateChannelInfoChatRequest) String

type UpdateChannelInfoRequest

type UpdateChannelInfoRequest struct {
	ChannelId string            `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	Topic     string            `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	Tags      map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*UpdateChannelInfoRequest) Descriptor deprecated

func (*UpdateChannelInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateChannelInfoRequest.ProtoReflect.Descriptor instead.

func (*UpdateChannelInfoRequest) GetChannelId

func (x *UpdateChannelInfoRequest) GetChannelId() string

func (*UpdateChannelInfoRequest) GetTags added in v0.4.0

func (x *UpdateChannelInfoRequest) GetTags() map[string]string

func (*UpdateChannelInfoRequest) GetTopic

func (x *UpdateChannelInfoRequest) GetTopic() string

func (*UpdateChannelInfoRequest) ProtoMessage

func (*UpdateChannelInfoRequest) ProtoMessage()

func (*UpdateChannelInfoRequest) ProtoReflect

func (x *UpdateChannelInfoRequest) ProtoReflect() protoreflect.Message

func (*UpdateChannelInfoRequest) Reset

func (x *UpdateChannelInfoRequest) Reset()

func (*UpdateChannelInfoRequest) String

func (x *UpdateChannelInfoRequest) String() string

type UpdateChannelInfoResponse

type UpdateChannelInfoResponse struct {
	// contains filtered or unexported fields
}

func (*UpdateChannelInfoResponse) Descriptor deprecated

func (*UpdateChannelInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateChannelInfoResponse.ProtoReflect.Descriptor instead.

func (*UpdateChannelInfoResponse) ProtoMessage

func (*UpdateChannelInfoResponse) ProtoMessage()

func (*UpdateChannelInfoResponse) ProtoReflect

func (*UpdateChannelInfoResponse) Reset

func (x *UpdateChannelInfoResponse) Reset()

func (*UpdateChannelInfoResponse) String

func (x *UpdateChannelInfoResponse) String() string

type User

type User struct {
	Id          string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

When sent by a chat backend, the ID MUST be unique across users in that running backend. Failure to follow this will result in incorrect information being sent to plugins. When sent by core to a plugin, the ID MUST be an ID pointing to an instance of a user on chat backend.

func (*User) Descriptor deprecated

func (*User) Descriptor() ([]byte, []int)

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetDisplayName

func (x *User) GetDisplayName() string

func (*User) GetId

func (x *User) GetId() string

func (*User) ProtoMessage

func (*User) ProtoMessage()

func (*User) ProtoReflect

func (x *User) ProtoReflect() protoreflect.Message

func (*User) Reset

func (x *User) Reset()

func (*User) String

func (x *User) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL