@valoranchi/riot-client / raw / OfficialApi

Class: OfficialApi

Defined in: src/official/OfficialApi.ts:25

Constructors

Constructor

new OfficialApi(gateway, apiKey?, options?): OfficialApi

Defined in: src/official/OfficialApi.ts:32

Parameters

gateway

HttpGateway

apiKey?

string

options?

OfficialApiOptions = {}

Returns

OfficialApi

Methods

accountByPuuid()

accountByPuuid(puuid): Promise<OfficialAccountResponse | null>

Defined in: src/official/OfficialApi.ts:51

Parameters

puuid

string

Returns

Promise<OfficialAccountResponse | null>

---

accountByRiotId()

accountByRiotId(gameName, tagLine): Promise<OfficialAccountResponse | null>

Defined in: src/official/OfficialApi.ts:41

Parameters

gameName

string

tagLine

string

Returns

Promise<OfficialAccountResponse | null>

---

activeShard()

activeShard(puuid, game?): Promise<OfficialActiveShardResponse | null>

Defined in: src/official/OfficialApi.ts:57

Parameters

puuid

string

game?

string = "val"

Returns

Promise<OfficialActiveShardResponse | null>

---

contents()

contents(shard, locale?): Promise<OfficialContentResponse>

Defined in: src/official/OfficialApi.ts:114

Parameters

shard

string

locale?

string

Returns

Promise<OfficialContentResponse>

---

leaderboard()

leaderboard(shard, actId, options?): Promise<OfficialLeaderboardResponse | null>

Defined in: src/official/OfficialApi.ts:98

Parameters

shard

string

actId

string

options?

size?

number

startIndex?

number

Returns

Promise<OfficialLeaderboardResponse | null>

---

match()

match(shard, matchId): Promise<OfficialMatchResponse | null>

Defined in: src/official/OfficialApi.ts:71

Parameters

shard

string

matchId

string

Returns

Promise<OfficialMatchResponse | null>

---

matchlist()

matchlist(shard, puuid): Promise<OfficialMatchlistResponse | null>

Defined in: src/official/OfficialApi.ts:64

Parameters

shard

string

puuid

string

Returns

Promise<OfficialMatchlistResponse | null>

---

platformStatus()

platformStatus(shard): Promise<OfficialPlatformData>

Defined in: src/official/OfficialApi.ts:122

Parameters

shard

string

Returns

Promise<OfficialPlatformData>

---

recentMatches()

recentMatches(shard, queue): Promise<OfficialRecentMatchesResponse | null>

Defined in: src/official/OfficialApi.ts:91

Parameters

shard

string

queue

string

Returns

Promise<OfficialRecentMatchesResponse | null>