gateway

type ActivityOpt func(activity *discord.Activity)

type AddedThreadMember struct {
	discord.ThreadMember
	Member   discord.Member    `json:"member"`
	Presence *discord.Presence `json:"presence"`
}

type CloseEventCode struct {
	Code        int
	Description string
	Explanation string
	Reconnect   bool
}

type CloseHandlerFunc func(gateway Gateway, err error, reconnect bool)

type CompressionType string

type ConfigOpt func(config *config)

type CreateFunc func(token string, eventHandlerFunc EventHandlerFunc, opts ...ConfigOpt) Gateway

type EventApplicationCommandPermissionsUpdate struct {
	discord.ApplicationCommandPermissions
}

type EventAutoModerationActionExecution struct {
	GuildID              snowflake.ID                      `json:"guild_id"`
	Action               discord.AutoModerationAction      `json:"action"`
	RuleID               snowflake.ID                      `json:"rule_id"`
	RuleTriggerType      discord.AutoModerationTriggerType `json:"rule_trigger_type"`
	UserID               snowflake.ID                      `json:"user_id"`
	ChannelID            *snowflake.ID                     `json:"channel_id,omitempty"`
	MessageID            *snowflake.ID                     `json:"message_id,omitempty"`
	AlertSystemMessageID snowflake.ID                      `json:"alert_system_message_id"`
	Content              string                            `json:"content"`
	MatchedKeywords      *string                           `json:"matched_keywords"`
	MatchedContent       *string                           `json:"matched_content"`
}

type EventAutoModerationRuleCreate struct {
	discord.AutoModerationRule
}

type EventAutoModerationRuleDelete struct {
	discord.AutoModerationRule
}

type EventAutoModerationRuleUpdate struct {
	discord.AutoModerationRule
}

type EventChannelCreate struct {
	discord.GuildChannel
}

type EventChannelDelete struct {
	discord.GuildChannel
}

type EventChannelPinsUpdate struct {
	GuildID          *snowflake.ID `json:"guild_id"`
	ChannelID        snowflake.ID  `json:"channel_id"`
	LastPinTimestamp *time.Time    `json:"last_pin_timestamp"`
}

type EventChannelUpdate struct {
	discord.GuildChannel
}

type EventData interface {
	MessageData
	// contains filtered or unexported methods
}

type EventEntitlementCreate struct {
	discord.Entitlement
}

type EventEntitlementDelete struct {
	discord.Entitlement
}

type EventEntitlementUpdate struct {
	discord.Entitlement
}

type EventGuildAuditLogEntryCreate struct {
	discord.AuditLogEntry
	GuildID snowflake.ID `json:"guild_id"`
}

type EventGuildBanAdd struct {
	GuildID snowflake.ID `json:"guild_id"`
	User    discord.User `json:"user"`
}

type EventGuildBanRemove struct {
	GuildID snowflake.ID `json:"guild_id"`
	User    discord.User `json:"user"`
}

type EventGuildCreate struct {
	discord.GatewayGuild
}

type EventGuildDelete struct {
	discord.UnavailableGuild
}

type EventGuildEmojisUpdate struct {
	GuildID snowflake.ID    `json:"guild_id"`
	Emojis  []discord.Emoji `json:"emojis"`
}

type EventGuildIntegrationsUpdate struct {
	GuildID snowflake.ID `json:"guild_id"`
}

type EventGuildMemberAdd struct {
	discord.Member
}

type EventGuildMemberRemove struct {
	GuildID snowflake.ID `json:"guild_id"`
	User    discord.User `json:"user"`
}

type EventGuildMemberUpdate struct {
	discord.Member
}

type EventGuildMembersChunk struct {
	GuildID    snowflake.ID       `json:"guild_id"`
	Members    []discord.Member   `json:"members"`
	ChunkIndex int                `json:"chunk_index"`
	ChunkCount int                `json:"chunk_count"`
	NotFound   []snowflake.ID     `json:"not_found"`
	Presences  []discord.Presence `json:"presences"`
	Nonce      string             `json:"nonce"`
}

type EventGuildRoleCreate struct {
	GuildID snowflake.ID `json:"guild_id"`
	Role    discord.Role `json:"role"`
}

type EventGuildRoleDelete struct {
	GuildID snowflake.ID `json:"guild_id"`
	RoleID  snowflake.ID `json:"role_id"`
}

type EventGuildRoleUpdate struct {
	GuildID snowflake.ID `json:"guild_id"`
	Role    discord.Role `json:"role"`
}

type EventGuildScheduledEventCreate struct {
	discord.GuildScheduledEvent
}

type EventGuildScheduledEventDelete struct {
	discord.GuildScheduledEvent
}

type EventGuildScheduledEventUpdate struct {
	discord.GuildScheduledEvent
}

type EventGuildScheduledEventUserAdd struct {
	GuildScheduledEventID snowflake.ID `json:"guild_scheduled_event_id"`
	UserID                snowflake.ID `json:"user_id"`
	GuildID               snowflake.ID `json:"guild_id"`
}

type EventGuildScheduledEventUserRemove struct {
	GuildScheduledEventID snowflake.ID `json:"guild_scheduled_event_id"`
	UserID                snowflake.ID `json:"user_id"`
	GuildID               snowflake.ID `json:"guild_id"`
}

type EventGuildSoundboardSoundCreate struct {
	discord.SoundboardSound
}

type EventGuildSoundboardSoundDelete struct {
	SoundID snowflake.ID `json:"sound_id"`
	GuildID snowflake.ID `json:"guild_id"`
}

type EventGuildSoundboardSoundUpdate struct {
	discord.SoundboardSound
}

type EventGuildSoundboardSoundsUpdate struct {
	SoundboardSounds []discord.SoundboardSound `json:"soundboard_sounds"`
	GuildID          snowflake.ID              `json:"guild_id"`
}

type EventGuildStickersUpdate struct {
	GuildID  snowflake.ID      `json:"guild_id"`
	Stickers []discord.Sticker `json:"stickers"`
}

type EventGuildUpdate struct {
	discord.GatewayGuild
}

type EventHandlerFunc func(gateway Gateway, eventType EventType, sequenceNumber int, event EventData)

type EventHeartbeatAck struct {
	LastHeartbeat time.Time
	NewHeartbeat  time.Time
}

type EventIntegrationCreate struct {
	discord.Integration
	GuildID snowflake.ID `json:"guild_id"`
}

type EventIntegrationDelete struct {
	ID            snowflake.ID  `json:"id"`
	GuildID       snowflake.ID  `json:"guild_id"`
	ApplicationID *snowflake.ID `json:"application_id"`
}

type EventIntegrationUpdate struct {
	discord.Integration
	GuildID snowflake.ID `json:"guild_id"`
}

type EventInteractionCreate struct {
	discord.Interaction
}

type EventInviteCreate struct {
	ChannelID         snowflake.ID                `json:"channel_id"`
	Code              string                      `json:"code"`
	CreatedAt         time.Time                   `json:"created_at"`
	GuildID           *snowflake.ID               `json:"guild_id"`
	Inviter           *discord.User               `json:"inviter"`
	MaxAge            int                         `json:"max_age"`
	MaxUses           int                         `json:"max_uses"`
	TargetType        discord.InviteTargetType    `json:"target_type"`
	TargetUser        *discord.User               `json:"target_user"`
	TargetApplication *discord.PartialApplication `json:"target_application"`
	Temporary         bool                        `json:"temporary"`
	Uses              int                         `json:"uses"`
	ExpiresAt         *time.Time                  `json:"expires_at"`
	RoleIDs           *[]snowflake.ID             `json:"role_ids"`
}

type EventInviteDelete struct {
	ChannelID snowflake.ID  `json:"channel_id"`
	GuildID   *snowflake.ID `json:"guild_id"`
	Code      string        `json:"code"`
}

type EventMessageCreate struct {
	discord.Message
}

type EventMessageDelete struct {
	ID        snowflake.ID  `json:"id"`
	ChannelID snowflake.ID  `json:"channel_id"`
	GuildID   *snowflake.ID `json:"guild_id,omitempty"`
}

type EventMessageDeleteBulk struct {
	IDs       []snowflake.ID `json:"ids"`
	ChannelID snowflake.ID   `json:"channel_id"`
	GuildID   *snowflake.ID  `json:"guild_id,omitempty"`
}

type EventMessagePollVoteAdd struct {
	UserID    snowflake.ID  `json:"user_id"`
	ChannelID snowflake.ID  `json:"channel_id"`
	MessageID snowflake.ID  `json:"message_id"`
	GuildID   *snowflake.ID `json:"guild_id"`
	AnswerID  int           `json:"answer_id"`
}

type EventMessagePollVoteRemove struct {
	UserID    snowflake.ID  `json:"user_id"`
	ChannelID snowflake.ID  `json:"channel_id"`
	MessageID snowflake.ID  `json:"message_id"`
	GuildID   *snowflake.ID `json:"guild_id"`
	AnswerID  int           `json:"answer_id"`
}

type EventMessageReactionAdd struct {
	UserID          snowflake.ID                `json:"user_id"`
	ChannelID       snowflake.ID                `json:"channel_id"`
	MessageID       snowflake.ID                `json:"message_id"`
	GuildID         *snowflake.ID               `json:"guild_id"`
	Member          *discord.Member             `json:"member"`
	Emoji           discord.PartialEmoji        `json:"emoji"`
	MessageAuthorID *snowflake.ID               `json:"message_author_id"`
	BurstColors     []string                    `json:"burst_colors"`
	Burst           bool                        `json:"burst"`
	Type            discord.MessageReactionType `json:"type"`
}

type EventMessageReactionRemove struct {
	UserID      snowflake.ID                `json:"user_id"`
	ChannelID   snowflake.ID                `json:"channel_id"`
	MessageID   snowflake.ID                `json:"message_id"`
	GuildID     *snowflake.ID               `json:"guild_id"`
	Emoji       discord.PartialEmoji        `json:"emoji"`
	BurstColors []string                    `json:"burst_colors"`
	Burst       bool                        `json:"burst"`
	Type        discord.MessageReactionType `json:"type"`
}

type EventMessageReactionRemoveAll struct {
	ChannelID snowflake.ID  `json:"channel_id"`
	MessageID snowflake.ID  `json:"message_id"`
	GuildID   *snowflake.ID `json:"guild_id"`
}

type EventMessageReactionRemoveEmoji struct {
	ChannelID snowflake.ID         `json:"channel_id"`
	MessageID snowflake.ID         `json:"message_id"`
	GuildID   *snowflake.ID        `json:"guild_id"`
	Emoji     discord.PartialEmoji `json:"emoji"`
}

type EventMessageUpdate struct {
	discord.Message
}

type EventPresenceUpdate struct {
	discord.Presence
}

type EventRateLimited struct {
	Opcode     Opcode              `json:"opcode"`
	RetryAfter float64             `json:"retry_after"`
	Meta       RateLimitedMetadata `json:"meta"`
}

type EventRaw struct {
	EventType EventType
	Payload   io.Reader
}

type EventReady struct {
	Version          int                        `json:"v"`
	User             discord.OAuth2User         `json:"user"`
	Guilds           []discord.UnavailableGuild `json:"guilds"`
	SessionID        string                     `json:"session_id"`
	ResumeGatewayURL string                     `json:"resume_gateway_url"`
	Shard            [2]int                     `json:"shard,omitempty"`
	Application      discord.PartialApplication `json:"application"`
}

type EventResumed struct{}

type EventSoundboardSounds struct {
	SoundboardSounds []discord.SoundboardSound `json:"soundboard_sounds"`
	GuildID          snowflake.ID              `json:"guild_id"`
}

type EventStageInstanceCreate struct {
	discord.StageInstance
}

type EventStageInstanceDelete struct {
	discord.StageInstance
}

type EventStageInstanceUpdate struct {
	discord.StageInstance
}

type EventSubscriptionCreate struct {
	discord.Subscription
}

type EventSubscriptionDelete struct {
	discord.Subscription
}

type EventSubscriptionUpdate struct {
	discord.Subscription
}

type EventThreadCreate struct {
	discord.GuildThread
	ThreadMember discord.ThreadMember `json:"thread_member"`
	NewlyCreated bool                 `json:"newly_created"`
}

type EventThreadDelete struct {
	ID       snowflake.ID        `json:"id"`
	GuildID  snowflake.ID        `json:"guild_id"`
	ParentID snowflake.ID        `json:"parent_id"`
	Type     discord.ChannelType `json:"type"`
}

type EventThreadListSync struct {
	GuildID    snowflake.ID           `json:"guild_id"`
	ChannelIDs []snowflake.ID         `json:"channel_ids"`
	Threads    []discord.GuildThread  `json:"threads"`
	Members    []discord.ThreadMember `json:"members"`
}

type EventThreadMemberUpdate struct {
	discord.ThreadMember
}

type EventThreadMembersUpdate struct {
	ID               snowflake.ID        `json:"id"`
	GuildID          snowflake.ID        `json:"guild_id"`
	MemberCount      int                 `json:"member_count"`
	AddedMembers     []AddedThreadMember `json:"added_members"`
	RemovedMemberIDs []snowflake.ID      `json:"removed_member_ids"`
}

type EventThreadUpdate struct {
	discord.GuildThread
}

type EventType string

type EventTypingStart struct {
	ChannelID snowflake.ID    `json:"channel_id"`
	GuildID   *snowflake.ID   `json:"guild_id,omitempty"`
	UserID    snowflake.ID    `json:"user_id"`
	Timestamp time.Time       `json:"timestamp"`
	Member    *discord.Member `json:"member,omitempty"`
	User      discord.User    `json:"user"`
}

type EventUnknown json.RawMessage

type EventUserUpdate struct {
	discord.OAuth2User
}

type EventVoiceChannelEffectSend struct {
	ChannelID     snowflake.ID                             `json:"channel_id"`
	GuildID       snowflake.ID                             `json:"guild_id"`
	UserID        snowflake.ID                             `json:"user_id"`
	Emoji         *discord.Emoji                           `json:"emoji"`
	AnimationType *discord.VoiceChannelEffectAnimationType `json:"animation_type,omitempty"`
	AnimationID   *int                                     `json:"animation_id,omitempty"`
	SoundID       *int64                                   `json:"-"`
	SoundVolume   *float64                                 `json:"sound_volume,omitempty"`
}

type EventVoiceServerUpdate struct {
	Token    string       `json:"token"`
	GuildID  snowflake.ID `json:"guild_id"`
	Endpoint *string      `json:"endpoint"`
}

type EventVoiceStateUpdate struct {
	discord.VoiceState
	Member discord.Member `json:"member"`
}

type EventWebhooksUpdate struct {
	GuildID   snowflake.ID `json:"guild_id"`
	ChannelID snowflake.ID `json:"channel_id"`
}

type Gateway interface {
	// ShardID returns the shard ID that this Gateway is configured to use.
	ShardID() int

	// ShardCount returns the total number of shards that this Gateway is configured to use.
	ShardCount() int

	// SessionID returns the session ID that is used by this Gateway.
	// This may be nil if the Gateway was never connected to Discord, was gracefully closed with websocket.CloseNormalClosure or websocket.CloseGoingAway.
	SessionID() *string

	// LastSequenceReceived returns the last sequence number that was received by the Gateway.
	// This may be nil if the Gateway was never connected to Discord, was gracefully closed with websocket.CloseNormalClosure or websocket.CloseGoingAway.
	LastSequenceReceived() *int

	// ResumeURL returns the resume url that was received by the Gateway
	ResumeURL() *string

	// Intents returns the Intents that are used by this Gateway.
	Intents() Intents

	// Open connects this Gateway to the Discord API.
	Open(ctx context.Context) error

	// Close gracefully closes the Gateway with the websocket.CloseNormalClosure code.
	// If the context is done, the Gateway connection will be killed.
	Close(ctx context.Context)

	// CloseWithCode closes the Gateway with the given code & message.
	// If the context is done, the Gateway connection will be killed.
	CloseWithCode(ctx context.Context, code int, message string)

	// Status returns the Status of the Gateway.
	Status() Status

	// Send sends a message to the Discord gateway with the opCode and data.
	// If context is deadline exceeds, the message sending will be aborted.
	Send(ctx context.Context, op Opcode, data MessageData) error

	// Latency returns the latency of the Gateway.
	// This is calculated by the time it takes to send a heartbeat and receive a heartbeat ack by discord.
	Latency() time.Duration

	// Presence returns the current presence of the Gateway.
	Presence() *MessageDataPresenceUpdate
}

type IdentifyCommandDataProperties struct {
	OS      string `json:"os"`      // user OS
	Browser string `json:"browser"` // library name
	Device  string `json:"device"`  // library name
}

type IdentifyRateLimiter interface {
	// Close gracefully closes the RateLimiter.
	// If the context deadline is exceeded, the RateLimiter will be closed immediately.
	Close(ctx context.Context)

	// Wait waits for the given shardID bucket to be available for new logins.
	// If the context deadline is exceeded, Wait will return immediately and no login will be attempted.
	Wait(ctx context.Context, shardID int) error

	// Unlock unlocks the given shardID bucket.
	// If Wait fails, Unlock should not be called.
	Unlock(shardID int)
}

type IdentifyRateLimiterConfigOpt func(config *identifyRateLimiterConfig)

type Intents int64

type Message struct {
	Op   Opcode          `json:"op"`
	S    int             `json:"s,omitempty"`
	T    EventType       `json:"t,omitempty"`
	D    MessageData     `json:"d,omitempty"`
	RawD json.RawMessage `json:"-"`
}

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

type MessageDataHeartbeat int

type MessageDataHeartbeatACK struct{}

type MessageDataHello struct {
	HeartbeatInterval int `json:"heartbeat_interval"`
}

type MessageDataIdentify struct {
	Token          string                        `json:"token"`
	Properties     IdentifyCommandDataProperties `json:"properties"`
	Compress       bool                          `json:"compress,omitempty"`
	LargeThreshold int                           `json:"large_threshold,omitempty"`
	Shard          *[2]int                       `json:"shard,omitempty"`
	Intents        Intents                       `json:"intents"`
	Presence       *MessageDataPresenceUpdate    `json:"presence,omitempty"`
}

type MessageDataInvalidSession bool

type MessageDataPresenceUpdate struct {
	Since      *int64               `json:"since"`
	Activities []discord.Activity   `json:"activities"`
	Status     discord.OnlineStatus `json:"status"`
	AFK        bool                 `json:"afk"`
}

type MessageDataReconnect struct{}

type MessageDataRequestGuildMembers struct {
	GuildID   snowflake.ID   `json:"guild_id"`
	Query     *string        `json:"query,omitempty"` // If specified, user_ids must not be entered
	Limit     *int           `json:"limit,omitempty"` // Must be >=1 if query/user_ids is used, otherwise 0
	Presences bool           `json:"presences,omitempty"`
	UserIDs   []snowflake.ID `json:"user_ids,omitempty"` // If specified, query must not be entered
	Nonce     string         `json:"nonce,omitempty"`    // All responses are hashed with this nonce, optional
}

type MessageDataRequestSoundboardSounds struct {
	GuildIDs []snowflake.ID `json:"guild_ids"`
}

type MessageDataResume struct {
	Token     string `json:"token"`
	SessionID string `json:"session_id"`
	Seq       int    `json:"seq"`
}

type MessageDataUnknown json.RawMessage

type MessageDataVoiceStateUpdate struct {
	GuildID   snowflake.ID  `json:"guild_id"`
	ChannelID *snowflake.ID `json:"channel_id"`
	SelfMute  bool          `json:"self_mute"`
	SelfDeaf  bool          `json:"self_deaf"`
}

type Opcode int

type PresenceOpt func(presenceUpdate *MessageDataPresenceUpdate)

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

type RateLimitedMetadataRequestGuildMembers struct {
	GuildID snowflake.ID `json:"guild_id"`
	Nonce   string       `json:"nonce"`
}

type RateLimitedMetadataUnknown json.RawMessage

type RateLimiter interface {
	// Close gracefully closes the RateLimiter.
	// If the context deadline is exceeded, the RateLimiter will be closed immediately.
	Close(ctx context.Context)

	// Reset resets the RateLimiter to its initial state.
	Reset()

	// Wait waits for the RateLimiter to be ready to send a new message.
	// If the context deadline is exceeded, Wait will return immediately and no message will be sent.
	Wait(ctx context.Context, commandType RateLimiterCommandType) error

	// Unlock unlocks the RateLimiter and allows the next message to be sent.
	Unlock()
}

type RateLimiterCommandType int

type RateLimiterConfigOpt func(config *rateLimiterConfig)

type Status int