riotclientv4

Documentation

Overview

Package riotclientv4 provides the Riot API client for API version v4

Index

• type RiotClientV4
  • func NewClient(httpClient httpClient, cfg config.RiotClient, ddragon dataDragon, ...) (*RiotClientV4, error)
  • func (c *RiotClientV4) ActiveGameBySummonerID(summonerID string) (*riotclient.CurrentGameInfoDTO, error)
  • func (c *RiotClientV4) ChampionRotations() (*riotclient.FreeRotation, error)
  • func (c *RiotClientV4) Champions() (s riotclient.ChampionsList, err error)
  • func (c *RiotClientV4) FeaturedGames() (*riotclient.FeaturedGamesDTO, error)
  • func (c *RiotClientV4) IsRunning() bool
  • func (c *RiotClientV4) Items(gameVersion, language string) (*riotclient.ItemList, error)
  • func (c *RiotClientV4) LeagueByQueue(league string, queue string) (*riotclient.LeagueListDTO, error)
  • func (c *RiotClientV4) LeaguesForSummoner(encSummonerID string) (*riotclient.LeaguePositionDTOList, error)
  • func (c *RiotClientV4) MatchByID(id uint64) (s *riotclient.MatchDTO, err error)
  • func (c *RiotClientV4) MatchTimeLineByID(matchID uint64) (t *riotclient.MatchTimelineDTO, err error)
  • func (c *RiotClientV4) MatchesByAccountID(accountID string, args map[string]string) (s *riotclient.MatchlistDTO, err error)
  • func (c *RiotClientV4) Start()
  • func (c *RiotClientV4) Stop()
  • func (c *RiotClientV4) SummonerByAccountID(accountID string) (s *riotclient.SummonerDTO, err error)
  • func (c *RiotClientV4) SummonerByName(name string) (s *riotclient.SummonerDTO, err error)
  • func (c *RiotClientV4) SummonerByPUUID(PUUID string) (s *riotclient.SummonerDTO, err error)
  • func (c *RiotClientV4) SummonerBySummonerID(summonerID string) (s *riotclient.SummonerDTO, err error)
  • func (c *RiotClientV4) SummonerSpells() (s *riotclient.SummonerSpellsList, err error)
  • func (c *RiotClientV4) Versions() (s riotclient.Versions, err error)

Types

type RiotClientV4

type RiotClientV4 struct {
	// contains filtered or unexported fields
}

RiotClientV4 Riot LoL API client

func NewClient

func NewClient(httpClient httpClient, cfg config.RiotClient,
	ddragon dataDragon,
	rateLimit *riotclientrl.RiotClientRL) (*RiotClientV4, error)

NewClient creates a new Riot LoL API client

func (*RiotClientV4) ActiveGameBySummonerID

func (c *RiotClientV4) ActiveGameBySummonerID(summonerID string) (*riotclient.CurrentGameInfoDTO, error)

ActiveGameBySummonerID returns the active game (live game) for the given Summoner ID

func (*RiotClientV4) ChampionRotations

func (c *RiotClientV4) ChampionRotations() (*riotclient.FreeRotation, error)

ChampionRotations returns the current free champions rotation from Riot API

func (*RiotClientV4) Champions

func (c *RiotClientV4) Champions() (s riotclient.ChampionsList, err error)

Champions gets all champions from Data Dragon

func (*RiotClientV4) FeaturedGames

func (c *RiotClientV4) FeaturedGames() (*riotclient.FeaturedGamesDTO, error)

FeaturedGames returns the currently features games from Riot

func (*RiotClientV4) IsRunning

func (c *RiotClientV4) IsRunning() bool

IsRunning returns if the Riot Client is currently started

func (*RiotClientV4) Items

func (c *RiotClientV4) Items(gameVersion, language string) (*riotclient.ItemList, error)

Items gets all items for a specific gameVersion and language from Data Dragon

func (*RiotClientV4) LeagueByQueue

func (c *RiotClientV4) LeagueByQueue(league string, queue string) (*riotclient.LeagueListDTO, error)

LeagueByQueue gets the requested league list by queue type Known values for league are "masterleagues", "grandmasterleagues", "challengerleagues" Allowed values for queue are "RANKED_SOLO_5x5", "RANKED_FLEX_SR", "RANKED_FLEX_TT"

func (*RiotClientV4) LeaguesForSummoner

func (c *RiotClientV4) LeaguesForSummoner(encSummonerID string) (*riotclient.LeaguePositionDTOList, error)

LeaguesForSummoner returns all Leagues a Summoner is ranked in

func (*RiotClientV4) MatchByID

func (c *RiotClientV4) MatchByID(id uint64) (s *riotclient.MatchDTO, err error)

MatchByID gets a match by its ID

func (*RiotClientV4) MatchTimeLineByID

func (c *RiotClientV4) MatchTimeLineByID(matchID uint64) (t *riotclient.MatchTimelineDTO, err error)

MatchTimeLineByID gets the Match TimeLine for a certain match identified by its MatchID/GameID

func (*RiotClientV4) MatchesByAccountID

func (c *RiotClientV4) MatchesByAccountID(accountID string, args map[string]string) (s *riotclient.MatchlistDTO, err error)

MatchesByAccountID gets a match by AccountID args: List of arguments to the query. They are directly passed to the request. Refer to https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchlist for details.

func (*RiotClientV4) Start

func (c *RiotClientV4) Start()

Start starts the riot client and its workers

func (*RiotClientV4) Stop

func (c *RiotClientV4) Stop()

Stop stops the riot client and its workers

func (*RiotClientV4) SummonerByAccountID

func (c *RiotClientV4) SummonerByAccountID(accountID string) (s *riotclient.SummonerDTO, err error)

SummonerByAccountID gets summoner data by its AccountID

func (*RiotClientV4) SummonerByName

func (c *RiotClientV4) SummonerByName(name string) (s *riotclient.SummonerDTO, err error)

SummonerByName gets summoner data by its name

func (*RiotClientV4) SummonerByPUUID

func (c *RiotClientV4) SummonerByPUUID(PUUID string) (s *riotclient.SummonerDTO, err error)

SummonerByPUUID gets summoner data by its PUUID

func (*RiotClientV4) SummonerBySummonerID

func (c *RiotClientV4) SummonerBySummonerID(summonerID string) (s *riotclient.SummonerDTO, err error)

SummonerBySummonerID gets summoner data by its SummonerID

func (*RiotClientV4) SummonerSpells

func (c *RiotClientV4) SummonerSpells() (s *riotclient.SummonerSpellsList, err error)

SummonerSpells gets all Summoner Spells from Data Dragon

func (*RiotClientV4) Versions

func (c *RiotClientV4) Versions() (s riotclient.Versions, err error)

Versions gets all versions from Data Dragon