badges

Documentation

Index

• type BadgeState
  • func NewBadgeState(log logger.Logger, env *libkb.Env) *BadgeState
  • func NewBadgeStateForServer(log logger.Logger) *BadgeState
  • func (b *BadgeState) Clear()
  • func (b *BadgeState) ConversationBadge(ctx context.Context, convID chat1.ConversationID) int
  • func (b *BadgeState) ConversationBadgeStr(ctx context.Context, convIDStr chat1.ConvIDStr) int
  • func (b *BadgeState) Export(ctx context.Context) (keybase1.BadgeState, error)
  • func (b *BadgeState) SetLocalChatState(s LocalChatState)
  • func (b *BadgeState) SetWalletAccountUnreadCount(accountID stellar1.AccountID, unreadCount int) bool
  • func (b *BadgeState) UpdateWithChat(ctx context.Context, update chat1.UnreadUpdate, inboxVers chat1.InboxVers, ...)
  • func (b *BadgeState) UpdateWithChatFull(ctx context.Context, update chat1.UnreadUpdateFull, isMobile bool)
  • func (b *BadgeState) UpdateWithGregor(ctx context.Context, gstate gregor.State) error
• type Badger
  • func NewBadger(g *libkb.GlobalContext) *Badger
  • func (b *Badger) Clear(ctx context.Context)
  • func (b *Badger) GetInboxVersionForTest(ctx context.Context) (chat1.InboxVers, error)
  • func (b *Badger) PushChatFullUpdate(ctx context.Context, update chat1.UnreadUpdateFull)
  • func (b *Badger) PushChatUpdate(ctx context.Context, update chat1.UnreadUpdate, inboxVers chat1.InboxVers)
  • func (b *Badger) PushState(ctx context.Context, state gregor.State)
  • func (b *Badger) Send(ctx context.Context) error
  • func (b *Badger) SetInboxVersionSource(s InboxVersionSource)
  • func (b *Badger) SetLocalChatState(s LocalChatState)
  • func (b *Badger) SetWalletAccountUnreadCount(ctx context.Context, accountID stellar1.AccountID, unreadCount int)
  • func (b *Badger) State() *BadgeState
• type InboxVersionSource
• type LocalChatState

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, env *libkb.Env) *BadgeState

NewBadgeState creates a new empty BadgeState.

func NewBadgeStateForServer

func NewBadgeStateForServer(log logger.Logger) *BadgeState

NewBadgeState creates a new empty BadgeState in contexts where notifications do not need to be handled.

func (*BadgeState) Clear

func (b *BadgeState) Clear()

func (*BadgeState) ConversationBadge

func (b *BadgeState) ConversationBadge(ctx context.Context, convID chat1.ConversationID) int

func (*BadgeState) ConversationBadgeStr

func (b *BadgeState) ConversationBadgeStr(ctx context.Context, convIDStr chat1.ConvIDStr) int

func (*BadgeState) Export

func (b *BadgeState) Export(ctx context.Context) (keybase1.BadgeState, error)

Exports the state summary

func (*BadgeState) SetLocalChatState

func (b *BadgeState) SetLocalChatState(s LocalChatState)

func (*BadgeState) SetWalletAccountUnreadCount

func (b *BadgeState) SetWalletAccountUnreadCount(accountID stellar1.AccountID, unreadCount int) bool

SetWalletAccountUnreadCount sets the unread count for a wallet account. It returns true if the call changed the unread count for accountID.

func (*BadgeState) UpdateWithChat

func (b *BadgeState) UpdateWithChat(ctx context.Context, update chat1.UnreadUpdate,
	inboxVers chat1.InboxVers, isMobile bool)

func (*BadgeState) UpdateWithChatFull

func (b *BadgeState) UpdateWithChatFull(ctx context.Context, update chat1.UnreadUpdateFull, isMobile bool)

func (*BadgeState) UpdateWithGregor

func (b *BadgeState) UpdateWithGregor(ctx context.Context, 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) GetInboxVersionForTest

func (b *Badger) GetInboxVersionForTest(ctx context.Context) (chat1.InboxVers, error)

func (*Badger) PushChatFullUpdate

func (b *Badger) PushChatFullUpdate(ctx context.Context, update chat1.UnreadUpdateFull)

func (*Badger) PushChatUpdate

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

func (*Badger) PushState

func (b *Badger) PushState(ctx context.Context, state gregor.State)

func (*Badger) Send

func (b *Badger) Send(ctx context.Context) error

Send the badgestate to electron

func (*Badger) SetInboxVersionSource

func (b *Badger) SetInboxVersionSource(s InboxVersionSource)

func (*Badger) SetLocalChatState

func (b *Badger) SetLocalChatState(s LocalChatState)

func (*Badger) SetWalletAccountUnreadCount

func (b *Badger) SetWalletAccountUnreadCount(ctx context.Context, accountID stellar1.AccountID, unreadCount int)

func (*Badger) State

func (b *Badger) State() *BadgeState

type InboxVersionSource

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

type LocalChatState

type LocalChatState interface {
	ApplyLocalChatState(context.Context, []keybase1.BadgeConversationInfo) ([]keybase1.BadgeConversationInfo, int, int)
}