Documentation
¶
Overview ¶
This package is used to interact with all LOR endpoints.
- DeckV1
- InventoryV1
- MatchV1
- RankedV1
- StatusV1
Note: this package is automatically generated.
Index ¶
- type CardV1DTO
- type Client
- type ContentV1DTO
- type DeckV1
- type DeckV1DTO
- type InfoV1DTO
- type InventoryV1
- type LeaderboardPlayerV1DTO
- type LeaderboardV1DTO
- type MatchV1
- type MatchV1DTO
- type MetadataV1DTO
- type NewDeckV1DTO
- type PlatformDataV1DTO
- type PlayerV1DTO
- type RankedV1
- type StatusV1
- type StatusV1DTO
- type UpdateV1DTO
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.19.0
type Client struct {
DeckV1 DeckV1
InventoryV1 InventoryV1
MatchV1 MatchV1
RankedV1 RankedV1
StatusV1 StatusV1
}
func NewLORClient ¶
Creates a new LOR Client using the internal.Client provided.
type ContentV1DTO ¶ added in v0.17.0
type ContentV1DTO struct {
Content string `json:"content,omitempty"`
Locale string `json:"locale,omitempty"`
}
ContentDto data object.
type DeckV1 ¶ added in v0.17.0
type DeckV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*DeckV1) CreateDeck ¶ added in v0.17.0
func (e *DeckV1) CreateDeck(ctx context.Context, route api.RegionalRoute, body *NewDeckV1DTO, authorization string) (string, error)
Create a new deck for the calling user.
Parameters ¶
- route : Route to query.
- Authorization
Riot API Reference ¶
type DeckV1DTO ¶ added in v0.17.0
type DeckV1DTO struct {
Code string `json:"code,omitempty"`
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
}
DeckDto data object.
type InfoV1DTO ¶ added in v0.17.0
type InfoV1DTO struct {
// (Legal values: Constructed, Expeditions, Tutorial)
GameMode string `json:"game_mode,omitempty"`
GameStartTimeUtc string `json:"game_start_time_utc,omitempty"`
// (Legal values: Ranked, Normal, AI, Tutorial, VanillaTrial, Singleton, StandardGauntlet)
GameType string `json:"game_type,omitempty"`
GameVersion string `json:"game_version,omitempty"`
Players []PlayerV1DTO `json:"players,omitempty"`
// Total turns taken by both players.
TotalTurnCount int32 `json:"total_turn_count,omitempty"`
}
InfoDto data object.
type InventoryV1 ¶ added in v0.17.0
type InventoryV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
type LeaderboardPlayerV1DTO ¶ added in v0.17.0
type LeaderboardPlayerV1DTO struct {
Name string `json:"name,omitempty"`
// League points.
LP int32 `json:"lp,omitempty"`
Rank int32 `json:"rank,omitempty"`
}
PlayerDto data object.
type LeaderboardV1DTO ¶ added in v0.17.0
type LeaderboardV1DTO struct {
// A list of players in Master tier.
Players []LeaderboardPlayerV1DTO `json:"players,omitempty"`
}
LeaderboardDto data object.
type MatchV1 ¶ added in v0.17.0
type MatchV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*MatchV1) ByID ¶ added in v0.17.0
func (e *MatchV1) ByID(ctx context.Context, route api.RegionalRoute, matchId string) (*MatchV1DTO, error)
Get match by id
Parameters ¶
- route : Route to query.
- matchId
Riot API Reference ¶
type MatchV1DTO ¶ added in v0.17.0
type MatchV1DTO struct {
// Match metadata.
Metadata MetadataV1DTO `json:"metadata,omitempty"`
// Match info.
Info InfoV1DTO `json:"info,omitempty"`
}
MatchDto data object.
type MetadataV1DTO ¶ added in v0.17.0
type MetadataV1DTO struct {
// Match data version.
DataVersion string `json:"data_version,omitempty"`
// Match id.
MatchID string `json:"match_id,omitempty"`
// A list of participant PUUIDs.
Participants []string `json:"participants,omitempty"`
}
MetadataDto data object.
type NewDeckV1DTO ¶ added in v0.17.0
type NewDeckV1DTO struct {
Code string `json:"code,omitempty"`
Name string `json:"name,omitempty"`
}
NewDeckDto data object.
type PlatformDataV1DTO ¶ added in v0.17.0
type PlatformDataV1DTO struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Incidents []StatusV1DTO `json:"incidents,omitempty"`
Locales []string `json:"locales,omitempty"`
Maintenances []StatusV1DTO `json:"maintenances,omitempty"`
}
PlatformDataDto data object.
type PlayerV1DTO ¶ added in v0.17.0
type PlayerV1DTO struct {
// Code for the deck played. Refer to LOR documentation for details on deck codes.
DeckCode string `json:"deck_code,omitempty"`
DeckID string `json:"deck_id,omitempty"`
GameOutcome string `json:"game_outcome,omitempty"`
PUUID string `json:"puuid,omitempty"`
Factions []string `json:"factions,omitempty"`
// The order in which the players took turns.
OrderOfPlay int32 `json:"order_of_play,omitempty"`
}
PlayerDto data object.
type RankedV1 ¶ added in v0.17.0
type RankedV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*RankedV1) Leaderboards ¶ added in v0.17.0
func (e *RankedV1) Leaderboards(ctx context.Context, route api.RegionalRoute) (*LeaderboardV1DTO, error)
Get the players in Master tier.
Parameters ¶
- route : Route to query.
Riot API Reference ¶
type StatusV1 ¶ added in v0.17.0
type StatusV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
type StatusV1DTO ¶ added in v0.17.0
type StatusV1DTO struct {
ArchiveAt string `json:"archive_at,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
// (Legal values: info, warning, critical)
IncidentSeverity string `json:"incident_severity,omitempty"`
// (Legal values: scheduled, in_progress, complete)
MaintenanceStatus string `json:"maintenance_status,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
// (Legal values: windows, macos, android, ios, ps4, xbone, switch)
Platforms []string `json:"platforms,omitempty"`
Titles []ContentV1DTO `json:"titles,omitempty"`
Updates []UpdateV1DTO `json:"updates,omitempty"`
ID int32 `json:"id,omitempty"`
}
StatusDto data object.
type UpdateV1DTO ¶ added in v0.17.0
type UpdateV1DTO struct {
Author string `json:"author,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
// (Legal values: riotclient, riotstatus, game)
PublishLocations []string `json:"publish_locations,omitempty"`
Translations []ContentV1DTO `json:"translations,omitempty"`
ID int32 `json:"id,omitempty"`
Publish bool `json:"publish,omitempty"`
}
UpdateDto data object.
Click to show internal directories.
Click to hide internal directories.