badge

Documentation

Overview

Package badge allows you to preserve, set or clear the number displayed on your App icon.

Index

• Variables
• type Badge
  • func New(number uint) Badge
  • func (b *Badge) Number() (uint, bool)

Variables

var Clear = Badge{/* contains filtered or unexported fields */}

Clear the badge.

var Preserve = Badge{}

Preserve the current badge (default behavior).

Types

type Badge

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

Badge number to display on the App icon.

func New

func New(number uint) Badge

New badge with a set value. A badge set to 0 is the same as badge.Clear.

func (*Badge) Number

func (b *Badge) Number() (uint, bool)

Number to display on the App Icon and if should be changed. If the badge should not be changed, the number has no effect.