microbadge

Documentation

Overview

Package microbadge contains functions to retrieve and set microbadges.

Index

• Constants
• func ClearSlot(slot uint) (err error)
• func SetAll(badgeNumbers []uint) (success bool, err error)
• func SetSlot(slot, badgeNumber uint) (success bool, err error)
• func ValidSlot(n uint) (result bool)
• type Group
• type Microbadge
  • func GetAll() (badges []Microbadge, err error)
  • func GetSlot(slot uint) (mb Microbadge, err error)
  • func (mb Microbadge) String() string

Constants

const TotalSlots = 5

Functions

func ClearSlot

func ClearSlot(slot uint) (err error)

ClearSlot clears the specified slot.

func SetAll

func SetAll(badgeNumbers []uint) (success bool, err error)

SetAll takes a collection of microbadge IDs and sends them to the server to set as the displayed microbadges.

func SetSlot

func SetSlot(slot, badgeNumber uint) (success bool, err error)

SetSlot updates the specified microbadge display slot with the microbadge specified by the ID passed in.

func ValidSlot

func ValidSlot(n uint) (result bool)

ValidSlot checks whether the specified number is a valid slot number, i.e. an integer between and 1 and the number of slots.

Types

type Group

type Group struct {
	GroupNumber uint
	Name        string
}

type Microbadge

type Microbadge struct {
	BadgeNumber    uint
	Name           string
	Category       Group
	Subcategory    Group
	Subsubcategory Group
	NumberOfOwners uint
	Mouseover      string
	Creator        string
	Description    string
	ImageFilename  string
}

func GetAll

func GetAll() (badges []Microbadge, err error)

GetAll returns a collection of all the user's microbadges.

func GetSlot

func GetSlot(slot uint) (mb Microbadge, err error)

GetSlot returns the microbadge in the specified slot.

func (Microbadge) String

func (mb Microbadge) String() string