badges

Documentation

Index

• type BadgeState
  • func NewBadgeState(log logger.Logger) *BadgeState
  • func (b *BadgeState) Clear()
  • func (b *BadgeState) Export() (keybase1.BadgeState, error)
  • func (b *BadgeState) UpdateWithChat(update chat1.UnreadUpdate, inboxVers chat1.InboxVers)
  • func (b *BadgeState) UpdateWithChatFull(update chat1.UnreadUpdateFull)
  • func (b *BadgeState) UpdateWithGregor(gstate gregor.State) error
• type Badger
  • func NewBadger(g *libkb.GlobalContext) *Badger
  • func (b *Badger) Clear(ctx context.Context)
  • func (b *Badger) PushChatUpdate(update chat1.UnreadUpdate, inboxVers chat1.InboxVers)
  • func (b *Badger) PushState(state gregor1.State)
  • func (b *Badger) Resync(ctx context.Context, chatRemote func() chat1.RemoteInterface, ...) error
  • func (b *Badger) Send() error
  • func (b *Badger) SetInboxVersionSource(s InboxVersionSource)
  • func (b *Badger) State() *BadgeState
• type InboxVersionSource

Types

type BadgeState

type BadgeState struct {
	sync.Mutex
	// contains filtered or unexported fields
}

BadgeState represents the number of badges on the app. It's threadsafe. Useable from both the client service and gregor server. See service:Badger for the service part that owns this.

func NewBadgeState

func NewBadgeState(log logger.Logger) *BadgeState

NewBadgeState creates a new empty BadgeState.

func (*BadgeState) Clear

func (b *BadgeState) Clear()

func (*BadgeState) Export

func (b *BadgeState) Export() (keybase1.BadgeState, error)

Exports the state summary

func (*BadgeState) UpdateWithChat

func (b *BadgeState) UpdateWithChat(update chat1.UnreadUpdate, inboxVers chat1.InboxVers)

func (*BadgeState) UpdateWithChatFull

func (b *BadgeState) UpdateWithChatFull(update chat1.UnreadUpdateFull)

func (*BadgeState) UpdateWithGregor

func (b *BadgeState) UpdateWithGregor(gstate gregor.State) error

UpdateWithGregor updates the badge state from a gregor state.

type Badger

type Badger struct {
	libkb.Contextified
	// contains filtered or unexported fields
}

Badger keeps a BadgeState up to date and broadcasts it to electron. This is the client-specific glue. The state is kept up to date by subscribing to: - All gregor state updates - All chat.activity gregor OOBMs - Logout

func NewBadger

func NewBadger(g *libkb.GlobalContext) *Badger

func (*Badger) Clear

func (b *Badger) Clear(ctx context.Context)

func (*Badger) PushChatUpdate

func (b *Badger) PushChatUpdate(update chat1.UnreadUpdate, inboxVers chat1.InboxVers)

func (*Badger) PushState

func (b *Badger) PushState(state gregor1.State)

func (*Badger) Resync

func (b *Badger) Resync(ctx context.Context, chatRemote func() chat1.RemoteInterface,
	gcli *grclient.Client, update *chat1.UnreadUpdateFull) error

func (*Badger) Send

func (b *Badger) Send() error

Send the badgestate to electron

func (*Badger) SetInboxVersionSource

func (b *Badger) SetInboxVersionSource(s InboxVersionSource)

func (*Badger) State

func (b *Badger) State() *BadgeState

type InboxVersionSource

type InboxVersionSource interface {
	GetInboxVersion(context.Context, gregor1.UID) (chat1.InboxVers, error)
}