Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

hirezapi

package

Go to main page

Versions in this module

v0

v0.0.8

Sep 2, 2022

v0.0.7

Mar 3, 2022

v0.0.6

Mar 2, 2022

Changes in this version

type APIClient

+ func (a *APIClient) GetGodAltAbilities() ([]models.GodAltAbility, error)

type HiRezAPI

+ GetGodAltAbilities func() ([]models.GodAltAbility, error)

v0.0.5

Feb 26, 2022

v0.0.4

May 27, 2021

v0.0.3

Apr 20, 2021

v0.0.2

Apr 17, 2021

v0.0.1

Apr 12, 2021

Changes in this version

+ const Adventures

+ const Arena

+ const ArenaAIEasy

+ const ArenaAIMedium

+ const ArenaChallenge

+ const ArenaPracticeEasy

+ const ArenaPracticeMedium

+ const ArenaTraining

+ const ArenaTutorial

+ const Assault

+ const AssaultAIEasy

+ const AssaultAIMedium

+ const AssaultChallenge

+ const AssaultPracticeEasy

+ const AssaultPracticeMedium

+ const BasicTutorial

+ const Bronze1

+ const Bronze2

+ const Bronze3

+ const Bronze4

+ const Bronze5

+ const Chinese

+ const Clash

+ const ClashAIEasy

+ const ClashAIMedium

+ const ClashChallenge

+ const ClashPracticeEasy

+ const ClashPracticeMedium

+ const ClashTutorial

+ const ClassicSiege

+ const ConqeustChallenge

+ const Conquest

+ const ConquestAIEasy

+ const ConquestAIMedium

+ const ConquestPracticeEasy

+ const ConquestPracticeMedium

+ const ConquestRanked

+ const ConquestTutorial

+ const CustomOnslaughtForemansRise

+ const CustomOnslaughtMagistratesArchives

+ const CustomOnslaughtPrimalCourt

+ const CustomOnslaughtSnowfallJunction

+ const CustomSiegeBrightmarsh

+ const CustomSiegeFishMarket

+ const CustomSiegeFrogIsle

+ const CustomSiegeFrozenGuard

+ const CustomSiegeIceMines

+ const CustomSiegeJaguarFalls

+ const CustomSiegeSerpentBeach

+ const CustomSiegeSplitstoneQuarry

+ const CustomSiegeStoneKeep

+ const CustomSiegeTimberMill

+ const CustomTDMForemansRise

+ const CustomTDMMagistrateArchives

+ const CustomTDMTradeDistrict

+ const DateFormat

+ const Diamond1

+ const Diamond2

+ const Diamond3

+ const Diamond4

+ const Diamond5

+ const Discord

+ const English

+ const Epic

+ const French

+ const German

+ const Gold1

+ const Gold2

+ const Gold3

+ const Gold4

+ const Gold5

+ const Grandmaster

+ const HiRez

+ const Joust

+ const Joust1v1Ranked

+ const Joust3v3Ranked

+ const Joust3v3Training

+ const JoustAIEasy

+ const JoustAIMedium

+ const JoustChallenge

+ const JoustPracticeEasy

+ const JunglePracicePreselect

+ const JunglePracitceMedium

+ const JunglePractice

+ const LiveBattleGroundsDuo

+ const LiveBattleGroundsQuad

+ const LiveBattlegroundsSolo

+ const LiveCasual

+ const LiveCompetitive

+ const LiveOnslaught

+ const LiveOnslaughtPractice

+ const LiveSiegePractice

+ const LiveTeamDeathmatch

+ const LiveTeamDeathmatchPractice

+ const LiveTestMaps

+ const Masters

+ const MatchOfTheDay

+ const PS4

+ const Platinum1

+ const Platinum2

+ const Platinum3

+ const Platinum4

+ const Platinum5

+ const Polish

+ const Portuguese

+ const Russian

+ const Siege

+ const SiegeChallenge

+ const Silver1

+ const Silver2

+ const Silver3

+ const Silver4

+ const Silver5

+ const Spanish

+ const SpanishLAM

+ const Steam

+ const Switch

+ const TimeFormat

+ const Turkish

+ const XBOX

+ func Contains(a []string, b string) bool

+ func FormatTime(t time.Time) string

+ func IsNotRanked(queueID string) bool

+ func IsPaladinsPath(basePath string) bool

+ func IsSmitePath(basePath string) bool

+ type APIClient struct

+ AuthKey string

+ BasePath string

+ DeveloperID string

+ RespType string

+ SessionID string

+ SessionStamp string

+ func (a *APIClient) ChangeBasePath(url MustBeURL)

+ func (a *APIClient) ChangeResponseType(respType MustBeResponseType)

+ func (a *APIClient) CreateSession() error

+ func (a *APIClient) GetBountyItems() ([]models.BountyItem, error)

+ func (a *APIClient) GetChampionCards(champID, langCode string) ([]models.ChampionCard, error)

+ func (a *APIClient) GetChampionLeaderboard(champID string) ([]models.ChampionLeaderboardEntry, error)

+ func (a *APIClient) GetChampionRanks(player string) ([]models.ChampionRank, error)

+ func (a *APIClient) GetChampionSkins(champID, langCode string) ([]models.ChampionSkin, error)

+ func (a *APIClient) GetChampions(langCode string) ([]models.Champion, error)

+ func (a *APIClient) GetDataUsed() ([]models.DataUsed, error)

+ func (a *APIClient) GetESportsProLeagueDetails() ([]models.ESportsProLeagueDetail, error)

+ func (a *APIClient) GetFriends(player string) ([]models.Friend, error)

+ func (a *APIClient) GetGodLeaderboard(godID, queueID string) ([]models.GodLeaderboardEntry, error)

+ func (a *APIClient) GetGodRanks(player string) ([]models.GodRank, error)

+ func (a *APIClient) GetGodRecommendedItems(godID int64, langCode string) ([]models.GodRecommendedItem, error)

+ func (a *APIClient) GetGodSkins(godID int64, langCode string) ([]models.GodSkin, error)

+ func (a *APIClient) GetGods(langCode string) ([]models.God, error)

+ func (a *APIClient) GetHiRezServerStatus() ([]models.HiRezServerStatus, error)

+ func (a *APIClient) GetItems(langCode string) ([]models.Item, error)

+ func (a *APIClient) GetLeagueLeaderboard(queueID, tier, round string) ([]models.LeagueLeaderboardEntry, error)

+ func (a *APIClient) GetLeagueSeasons(queueID string) ([]models.Season, error)

+ func (a *APIClient) GetMOTD() ([]models.MOTD, error)

+ func (a *APIClient) GetMatchDetails(matchID string) ([]models.MatchPlayer, error)

+ func (a *APIClient) GetMatchDetailsBatch(matchIDs []string) ([]models.MatchPlayer, error)

+ func (a *APIClient) GetMatchHistory(player string) ([]models.Match, error)

+ func (a *APIClient) GetMatchIDsByQueue(queueID, date, hour string) ([]models.Match, error)

+ func (a *APIClient) GetMatchPlayerDetails(matchID string) ([]models.LiveMatchPlayer, error)

+ func (a *APIClient) GetOrganizedMatchDetailsBatch(matchIDs []string) ([][]models.MatchPlayer, error)

+ func (a *APIClient) GetPatchInfo() (*models.VersionInfo, error)

+ func (a *APIClient) GetPlayer(player string) ([]models.Player, error)

+ func (a *APIClient) GetPlayerAchievements(playerID string) (*models.PlayerAchievements, error)

+ func (a *APIClient) GetPlayerBatch(playerIDs []string) ([]models.Player, error)

+ func (a *APIClient) GetPlayerByPlatform(player, portalID string) ([]models.Player, error)

+ func (a *APIClient) GetPlayerIDByName(player string) ([]models.PlayerIDInfo, error)

+ func (a *APIClient) GetPlayerIDByPortalUserID(portalID, portalUserID string) ([]models.PlayerIDInfo, error)

+ func (a *APIClient) GetPlayerIDInfoForXBOXAndSwitch(player string) ([]models.PlayerIDInfoForXBOXAndSwitch, error)

+ func (a *APIClient) GetPlayerIDsByGamertag(portalID, gamerTag string) ([]models.PlayerIDInfo, error)

+ func (a *APIClient) GetPlayerLoadouts(player, langCode string) ([]models.PlayerLoadout, error)

+ func (a *APIClient) GetPlayerStatus(player string) ([]models.PlayerStatus, error)

+ func (a *APIClient) GetQueueStats(player, queueID string) ([]models.PlayerGodQueueStat, error)

+ func (a *APIClient) GetTeamDetails(clanID string) ([]models.TeamDetail, error)

+ func (a *APIClient) GetTeamPlayers(clanID string) ([]models.TeamPlayer, error)

+ func (a *APIClient) GetTopMatches() ([]models.TopMatch, error)

+ func (a *APIClient) Ping() error

+ func (a *APIClient) SearchPlayers(searchPlayer string) ([]models.PlayerIDInfo, error)

+ func (a *APIClient) SearchTeams(searchTeam string) ([]models.TeamDetail, error)

+ func (a *APIClient) TestSession() (string, error)

+ type HiRezAPI interface

+ ChangeBasePath func(url MustBeURL)

+ ChangeResponseType func(respType MustBeResponseType)

+ CreateSession func() error

+ GetBountyItems func() ([]models.BountyItem, error)

+ GetChampionCards func(champID, langCode string) ([]models.ChampionCard, error)

+ GetChampionLeaderboard func(champID string) ([]models.ChampionLeaderboardEntry, error)

+ GetChampionRanks func(player string) ([]models.ChampionRank, error)

+ GetChampionSkins func(champID, langCode string) ([]models.ChampionSkin, error)

+ GetChampions func(langCode string) ([]models.Champion, error)

+ GetDataUsed func() ([]models.DataUsed, error)

+ GetESportsProLeagueDetails func() ([]models.ESportsProLeagueDetail, error)

+ GetFriends func(player string) ([]models.Friend, error)

+ GetGodLeaderboard func(godID, queueID string) ([]models.GodLeaderboardEntry, error)

+ GetGodRanks func(player string) ([]models.GodRank, error)

+ GetGodRecommendedItems func(godID int64, langCode string) ([]models.GodRecommendedItem, error)

+ GetGodSkins func(godID int64, langCode string) ([]models.GodSkin, error)

+ GetGods func(langCode string) ([]models.God, error)

+ GetHiRezServerStatus func() ([]models.HiRezServerStatus, error)

+ GetItems func(langCode string) ([]models.Item, error)

+ GetLeagueLeaderboard func(queueID, tier, round string) ([]models.LeagueLeaderboardEntry, error)

+ GetLeagueSeasons func(queueID string) ([]models.Season, error)

+ GetMOTD func() ([]models.MOTD, error)

+ GetMatchDetails func(matchID string) ([]models.MatchPlayer, error)

+ GetMatchDetailsBatch func(matchIDs []string) ([]models.MatchPlayer, error)

+ GetMatchHistory func(player string) ([]models.Match, error)

+ GetMatchIDsByQueue func(queueID, date, hour string) ([]models.Match, error)

+ GetMatchPlayerDetails func(matchID string) ([]models.LiveMatchPlayer, error)

+ GetOrganizedMatchDetailsBatch func(matchIDs []string) ([][]models.MatchPlayer, error)

+ GetPatchInfo func() (*models.VersionInfo, error)

+ GetPlayer func(player string) ([]models.Player, error)

+ GetPlayerAchievements func(playerID string) (*models.PlayerAchievements, error)

+ GetPlayerBatch func(playerIDs []string) ([]models.Player, error)

+ GetPlayerByPlatform func(player, portalID string) ([]models.Player, error)

+ GetPlayerIDByName func(player string) ([]models.PlayerIDInfo, error)

+ GetPlayerIDByPortalUserID func(portalID, portalUserID string) ([]models.PlayerIDInfo, error)

+ GetPlayerIDInfoForXBOXAndSwitch func(player string) ([]models.PlayerIDInfoForXBOXAndSwitch, error)

+ GetPlayerIDsByGamertag func(portalID, gamerTag string) ([]models.PlayerIDInfo, error)

+ GetPlayerLoadouts func(player, langCode string) ([]models.PlayerLoadout, error)

+ GetPlayerStatus func(player string) ([]models.PlayerStatus, error)

+ GetQueueStats func(player, queueID string) ([]models.PlayerGodQueueStat, error)

+ GetTeamDetails func(clanID string) ([]models.TeamDetail, error)

+ GetTeamPlayers func(clanID string) ([]models.TeamPlayer, error)

+ GetTopMatches func() ([]models.TopMatch, error)

+ Ping func() error

+ SearchPlayers func(searchPlayer string) ([]models.PlayerIDInfo, error)

+ SearchTeams func(searchTeam string) ([]models.TeamDetail, error)

+ TestSession func() (string, error)

+ func New(devID, key string, url MustBeURL, respType MustBeResponseType) (HiRezAPI, error)

+ func NewWithSession(devID, key string, url URL, respType MustBeResponseType) (HiRezAPI, error)

+ type MustBeResponseType interface

+ IsResponseType func() bool

+ String func() string

+ type MustBeURL interface

+ IsURL func() bool

+ String func() string

+ type ResponseType int

+ const ResponseTypeJSON

+ const ResponseTypeXML

+ func (r ResponseType) IsResponseType() bool

+ func (r ResponseType) String() string

+ type URL int

+ const URLPaladinsPC

+ const URLSmitePC

+ func (u URL) IsURL() bool

+ func (u URL) String() string