read

Documentation

Overview

Package read implements a read state with an event handler API.

Index

• type State
  • func NewState(state *state.State, r handlerrepo.AddHandler) *State
  • func (r *State) MarkRead(chID discord.ChannelID, msgID discord.MessageID)
  • func (r *State) MarkUnread(chID discord.ChannelID, msgID discord.MessageID, mentions int)
  • func (r *State) ReadState(channelID discord.ChannelID) *gateway.ReadState
  • func (r *State) SelfID() discord.UserID
• type UpdateEvent
  • func (ev UpdateEvent) EventType() ws.EventType
  • func (ev UpdateEvent) Op() ws.OpCode

Types

type State

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

func NewState

func NewState(state *state.State, r handlerrepo.AddHandler) *State

func (*State) MarkRead

func (r *State) MarkRead(chID discord.ChannelID, msgID discord.MessageID)

func (*State) MarkUnread

func (r *State) MarkUnread(chID discord.ChannelID, msgID discord.MessageID, mentions int)

func (*State) ReadState

func (r *State) ReadState(channelID discord.ChannelID) *gateway.ReadState

ReadState gets the read state for a channel.

func (*State) SelfID

func (r *State) SelfID() discord.UserID

type UpdateEvent

type UpdateEvent struct {
	gateway.ReadState
	GuildID discord.GuildID
	Unread  bool
}

func (UpdateEvent) EventType

func (ev UpdateEvent) EventType() ws.EventType

func (UpdateEvent) Op

func (ev UpdateEvent) Op() ws.OpCode