overwatch

Documentation

Index

• Constants
• Variables
• func CheckPlatform(platform string)
• func CheckRegion(region string)
• func NewCaching(overwatch OverwatchAPI, cache cache.Cache) *cachingOverwatch
• func RankToDivision(rank int) string
• type OfficialAPI
• type OverwatchAPI
• type RegionalOverwatchAPI

Constants

const (
	RegionUS     = "us"
	RegionEU     = "eu"
	RegionKR     = "kr"
	RegionCN     = "cn"
	RegionGlobal = "global"

	PlatformPC  = "pc"
	PlatformPSN = "psn"
	PlatformXBL = "xbl"

	SkillRankError = -1
)

Variables

var (
	Error            = errors.NewClass("overwatch")
	BattleTagInvalid = Error.NewClass("BattleTag invalid",
		errors.NoCaptureStack())
	BattleTagNotFound = Error.NewClass("no BattleTag found",
		errors.NoCaptureStack())
	BattleTagUnranked = Error.NewClass("no skill ranking found",
		errors.NoCaptureStack())
)

var (
	Regions   = []string{RegionUS, RegionEU, RegionKR, RegionCN, RegionGlobal}
	Platforms = []string{PlatformPC, PlatformPSN, PlatformXBL}
)

Functions

func CheckPlatform

func CheckPlatform(platform string)

func CheckRegion

func CheckRegion(region string)

func NewCaching

func NewCaching(overwatch OverwatchAPI, cache cache.Cache) *cachingOverwatch

func RankToDivision

func RankToDivision(rank int) string

Types

type OfficialAPI

type OfficialAPI interface {
	IsValidBattleTag(platform, region, battle_tag string) (
		bool, error)
}

type OverwatchAPI

type OverwatchAPI interface {
	SkillRank(platform, battle_tag string) (sr int, err error)
	OfficialAPI
}

type RegionalOverwatchAPI

type RegionalOverwatchAPI interface {
	SkillRank(platform, region, battle_tag string) (sr int, err error)
	OfficialAPI
}