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) FindLast(channelID discord.ChannelID) *gateway.ReadState
  • 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) OnUpdate(fn func(*UpdateEvent)) (rm func())
• type UpdateEvent

Types

type State

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

func NewState

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

func (*State) FindLast

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

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) OnUpdate

func (r *State) OnUpdate(fn func(*UpdateEvent)) (rm func())

OnUpdate adds a read update callback into the list. This function is thread-safe. It is synchronous by default.

type UpdateEvent

type UpdateEvent struct {
	gateway.ReadState
	Unread bool
}