streak

Documentation

Index

• Variables
• func Appearance(person, place int64, when time.Time) (int64, error)
• func Get(person, place int64) (int64, error)
• func GraceGet(place int64) (time.Duration, error)
• func GraceSet(place int64, grace time.Duration) error
• func Off(h *twitch.Helix, place int64) error
• func On(h *twitch.Helix, place int64, broadcasterID string) (core.Urr, error)
• func RedeemGet(place int64) (uuid.UUID, core.Urr, error)
• func RedeemSet(place int64, id string) error
• func Set(person, place int64, streak int) error

Variables

var (
	ErrIgnore    = errors.New("stream online within grace period, do nothing")
	UrrAlreadyOn = core.UrrNew("Streak tracking has already been turned on.")
)

var Admin = admin{}

var AdminSet = adminSet{}

var AdminShow = adminShow{}

var Advanced = advanced{}

var AdvancedGrace = advancedGrace{}

var AdvancedGraceSet = advancedGraceSet{}

var AdvancedGraceShow = advancedGraceShow{}

var AdvancedOff = advancedOff{}

var AdvancedOn = advancedOn{}

var AdvancedRedeem = advancedRedeem{}

var AdvancedRedeemSet = advancedRedeemSet{}

var AdvancedRedeemShow = advancedRedeemShow{}

var AdvancedShow = advancedShow{}

var Normal = normal{}

var NormalGrace = normalGrace{}

var NormalOff = normalOff{}

var NormalOn = normalOn{}

var NormalRedeem = normalRedeem{}

var UrrInvalidDuration = core.UrrNew("provided duration could not be parsed")

Functions

func Appearance

func Appearance(person, place int64, when time.Time) (int64, error)

Appearance returns the person's current streak with when being their latest appearance. Accounts for offline -> online within grace; for more info: core/events.go. If a stream is missed, the streak gets reset to 0.

func Get

func Get(person, place int64) (int64, error)

Get returns the person's current streak.

func GraceGet

func GraceGet(place int64) (time.Duration, error)

GraceGet returns the place's grace period. For more info: core/events.go.

func GraceSet

func GraceSet(place int64, grace time.Duration) error

GraceSet updates the place's grace period. For more info: core/events.go.

func Off

func Off(h *twitch.Helix, place int64) error

func On

func On(h *twitch.Helix, place int64, broadcasterID string) (core.Urr, error)

func RedeemGet

func RedeemGet(place int64) (uuid.UUID, core.Urr, error)

RedeemGet returns the place's streak triggering redeem. If no redeem has been set returns core.UrrValNil.

func RedeemSet

func RedeemSet(place int64, id string) error

RedeemSet updates the place's streak redeem id.

func Set

func Set(person, place int64, streak int) error

Set updates the person's current streak.