riot_wrapper

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 6, 2025 License: MIT Imports: 5 Imported by: 0

README

riot-wrapper

a simple wrapper for the riot api

Installation

go get github.com/ElderLab/riot-wrapper

Documentation

Index

Constants

View Source 
const (
	// MASTER is a rank type
	MASTER rank = "MASTER"
	// GRANDMASTER is a rank type
	GRANDMASTER rank = "GRANDMASTER"
	// CHALLENGER is a rank type
	CHALLENGER rank = "CHALLENGER"
)
View Source 
const (
	// RankedSolo5x5 is a queue type.
	RankedSolo5x5 queue = "RANKED_SOLO_5x5"
	// RankedFlexSR is a queue type.
	RankedFlexSR queue = "RANKED_FLEX_SR"
	// RankedFlexTT is a queue type.
	RankedFlexTT queue = "RANKED_FLEX_TT"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type RiotClient 

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

RiotClient is a struct that contains the RiotClient.

func NewRiotClient 

func NewRiotClient(Token string) *RiotClient

NewRiotClient is a function that returns a new RiotClient.

func (*RiotClient) GetAccountByPuuid 

func (cli *RiotClient) GetAccountByPuuid(puuid string) (*response.Account, error)

GetAccountByPuuid is a function that returns the account ID for a given PUUID.

func (*RiotClient) GetAccountByRiotId 

func (cli *RiotClient) GetAccountByRiotId(gameName, tagLine string) (*response.Account, error)

GetAccountByRiotId is a function that returns the account ID for a given gameName and tagLine.

func (*RiotClient) GetActiveGame 

func (cli *RiotClient) GetActiveGame(puuid string) (*response.ActiveGame, error)

func (*RiotClient) GetAllChampionMastery 

func (cli *RiotClient) GetAllChampionMastery(puuid string) (*[]response.ChampionMastery, error)

GetAllChampionMastery is a function that returns all the champion mastery of a summoner by PUUID.

func (*RiotClient) GetChallengerLeagueByQueue 

func (cli *RiotClient) GetChallengerLeagueByQueue(queue queue) (*response.League, error)

GetChallengerLeagueByQueue is a function that returns the challenger league for a given queue.

func (*RiotClient) GetChallengesConfig 

func (cli *RiotClient) GetChallengesConfig() (*[]response.Challenges, error)

GetChallengesConfig returns the challenges configuration

func (*RiotClient) GetChallengesConfigById 

func (cli *RiotClient) GetChallengesConfigById(id int) (*response.Challenges, error)

GetChallengesConfigById returns the challenges configuration by ID

func (*RiotClient) GetChallengesLeaderboards 

func (cli *RiotClient) GetChallengesLeaderboards(challengeId int, level rank) (*[]response.ChallengesLeaderboards, error)

GetChallengesLeaderboards returns the challenges leaderboards

func (*RiotClient) GetChallengesLeaderboardsWithOpts 

func (cli *RiotClient) GetChallengesLeaderboardsWithOpts(challengeId int, level rank, opts opts.ChallengesLeaderboardsOpts) (*[]response.ChallengesLeaderboards, error)

GetChallengesLeaderboardsWithOpts returns the challenges leaderboards with options

func (*RiotClient) GetChallengesPercentiles 

func (cli *RiotClient) GetChallengesPercentiles() (*response.AllChallengesPercentiles, error)

GetChallengesPercentiles returns all challenges percentiles

func (*RiotClient) GetChallengesPercentilesById 

func (cli *RiotClient) GetChallengesPercentilesById(challengeId int) (*response.ChallengesPercentiles, error)

GetChallengesPercentilesById returns the challenges percentiles by challenge ID

func (*RiotClient) GetChallengesPlayerProgression 

func (cli *RiotClient) GetChallengesPlayerProgression(puuid string) (*response.ChallengesProgression, error)

func (*RiotClient) GetChampionMastery 

func (cli *RiotClient) GetChampionMastery(puuid string) (*[]response.ChampionMastery, error)

GetChampionMastery is a function that returns the champion mastery of a summoner by PUUID.

func (*RiotClient) GetChampionMasteryById 

func (cli *RiotClient) GetChampionMasteryById(puuid string, championId int) (*response.ChampionMastery, error)

GetChampionMasteryById is a function that returns the champion mastery of a summoner by PUUID and champion ID.

func (*RiotClient) GetChampionMasteryScore 

func (cli *RiotClient) GetChampionMasteryScore(puuid string) (int, error)

GetChampionMasteryScore is a function that returns the champion mastery score of a summoner by PUUID.

func (*RiotClient) GetChampionMasteryWithOpts 

func (cli *RiotClient) GetChampionMasteryWithOpts(puuid string, opts opts.ChampionMasteryOpts) (*[]response.ChampionMastery, error)

GetChampionMasteryWithOpts is a function that returns the champion mastery of a summoner by PUUID with options.

func (*RiotClient) GetChampionRotation 

func (cli *RiotClient) GetChampionRotation() (string, error)

GetChampionRotation is a function that returns the free champion rotation for the current week.

func (*RiotClient) GetGrandmasterLeagueByQueue 

func (cli *RiotClient) GetGrandmasterLeagueByQueue(queue queue) (*response.League, error)

GetGrandmasterLeagueByQueue is a function that returns the grandmaster league for a given queue.

func (*RiotClient) GetMasterLeagueByQueue 

func (cli *RiotClient) GetMasterLeagueByQueue(queue queue) (*response.League, error)

GetMasterLeagueByQueue is a function that returns the master league for a given queue.

func (*RiotClient) GetMatchById 

func (cli *RiotClient) GetMatchById(matchId string) (*response.Match, error)

GetMatchById is a function that returns a match details by match ID.

func (*RiotClient) GetMatchTimelineById 

func (cli *RiotClient) GetMatchTimelineById(matchId string) (*response.MatchTimeline, error)

GetMatchTimelineById is a function that returns a match timeline by match ID.

func (*RiotClient) GetMatchesIds 

func (cli *RiotClient) GetMatchesIds(puuid string) (*response.MatchesIds, error)

GetMatchesIds is a function that returns a list of match IDs by PUUID.

func (*RiotClient) GetMatchesIdsWithOpts 

func (cli *RiotClient) GetMatchesIdsWithOpts(puuid string, opts opts.MatchesIdsOpts) (*response.MatchesIds, error)

GetMatchesIdsWithOpts is a function that returns a list of match IDs by PUUID with options.

func (*RiotClient) GetPlayerRankBySummonerId 

func (cli *RiotClient) GetPlayerRankBySummonerId(summonerId string) ([]response.PlayerRank, error)

GetPlayerRankBySummonerId is a function that returns a list of player rank by summoner ID.

func (*RiotClient) GetSummonerByAccountId 

func (cli *RiotClient) GetSummonerByAccountId(accountId string) (*response.Summoner, error)

GetSummonerByAccountId is a function that returns a summoner by AccountId.

func (*RiotClient) GetSummonerByPUUID 

func (cli *RiotClient) GetSummonerByPUUID(puuid string) (*response.Summoner, error)

GetSummonerByPUUID is a function that returns a summoner by PUUID.

Source Files

View all Source files

Directories

Path Synopsis
cmd
App command
Discord-Bot command
internal
request
models
opts
response
pkg
errors

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.