badge

Documentation

Overview

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

Example

package main

import (
	"fmt"

	"github.com/RobotsAndPencils/buford/payload/badge"
)

func main() {
	var b badge.Badge
	fmt.Println(b)

	fmt.Println(badge.Preserve)
	fmt.Println(badge.Clear)
	fmt.Println(badge.New(42))

}

Output:

preserve
preserve
set 0
set 42

Index

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

Examples

• Package

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.

func (Badge) String

func (b Badge) String() string

String prints out a badge