riot

Documentation

Index

• Constants
• type AccountDTO
• type AccountEndpoint
  • func (e *AccountEndpoint) ByAccessToken(accessToken string) (*AccountDTO, error)
  • func (e *AccountEndpoint) ByID(gameName string, tagLine string) (*AccountDTO, error)
  • func (e *AccountEndpoint) ByPUUID(puuid string) (*AccountDTO, error)
  • func (e *AccountEndpoint) PlayerActiveShard(puuid string, game api.Game) (*ActiveShardDTO, error)
• type ActiveShardDTO
• type RiotClient
  • func NewRiotClient(client *internal.InternalClient) *RiotClient

Constants

const (
	AccountActiveShardURL   = "/riot/account/v1/active-shards/by-game/%s/by-puuid/%s"
	AccountByPUUIDURL       = "/riot/account/v1/accounts/by-puuid/%s"
	AccountByRiotIDURL      = "/riot/account/v1/accounts/by-riot-id/%s/%s"
	AccountByAccessTokenURL = "/riot/account/v1/accounts/me"
)

Riot endpoint URLs.

Types

type AccountDTO

type AccountDTO struct {
	PUUID string `json:"puuid"`
	// This field may be excluded from the response if the account doesn't have a gameName.
	GameName string `json:"gameName,omitempty"`
	// This field may be excluded from the response if the account doesn't have a tagLine.
	TagLine string `json:"tagLine,omitempty"`
}

type AccountEndpoint

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

func (*AccountEndpoint) ByAccessToken

func (e *AccountEndpoint) ByAccessToken(accessToken string) (*AccountDTO, error)

Get account by access token.

func (*AccountEndpoint) ByID

func (e *AccountEndpoint) ByID(gameName string, tagLine string) (*AccountDTO, error)

Get account by riot ID.

func (*AccountEndpoint) ByPUUID

func (e *AccountEndpoint) ByPUUID(puuid string) (*AccountDTO, error)

Get account by PUUID.

func (*AccountEndpoint) PlayerActiveShard

func (e *AccountEndpoint) PlayerActiveShard(puuid string, game api.Game) (*ActiveShardDTO, error)

Get active shard for a player.

type ActiveShardDTO

type ActiveShardDTO struct {
	PUUID       string   `json:"puuid"`
	Game        api.Game `json:"game"`
	ActiveShard string   `json:"activeShard"`
}

type RiotClient

type RiotClient struct {
	Account *AccountEndpoint
	// contains filtered or unexported fields
}

func NewRiotClient

func NewRiotClient(client *internal.InternalClient) *RiotClient

Returns a new RiotClient using the InternalClient provided.