tft_league: TFT League End Point R6 class

In its-gazza/riotR: Riot! API Wrapper for R

Description

Sub class for [tft] to access [TFT-LEAGUE-V1](https://developer.riotgames.com/apis#tft-league-v1) end points.

Public fields

api

Riot API

region

API region, acceptable values: BR1, EUN1, EUW1, JP1, KR, LA1, LA2, NA1, OC1, TR1, RU

dry_run

If true all end point call will return glued URL

Methods

Public methods

• tft_league$new()

• tft_league$challenger()

• tft_league$grandmaster()

• tft_league$master()

• tft_league$by_summoner()

• tft_league$by_tier()

• tft_league$by_leagueId()

• tft_league$clone()

---

Method new()

Create a new tft object

Usage

tft_league$new(api, region, dry_run)

Arguments

api

Riot API

region

Access region

dry_run

Whether to call API

Returns

A new 'tft' object

---

Method challenger()

Get challenger league. For more info see [here](https://developer.riotgames.com/apis#tft-league-v1/GET_getChallengerLeague)

Usage

tft_league$challenger(region = self$region, dry_run = self$dry_run)

Arguments

region

Region to query. Default to class's region. Can overwrite.

---

Method grandmaster()

Get grandmaster league. For more info see [here](https://developer.riotgames.com/apis#tft-league-v1/GET_getGrandmasterLeague)

Usage

tft_league$grandmaster(region = self$region, dry_run = self$dry_run)

Arguments

region

Region to query. Default to class's region. Can overwrite.

---

Method master()

Get master league. For more info see [here](https://developer.riotgames.com/apis#tft-league-v1/GET_getMasterLeague)

Usage

tft_league$master(region = self$region, dry_run = self$dry_run)

Arguments

region

Region to query. Default to class's region. Can overwrite.

---

Method by_summoner()

Search client by

Usage

tft_league$by_summoner(
  summonerName = NULL,
  region = self$region,
  dry_run = self$dry_run
)

---

Method by_tier()

Usage

tft_league$by_tier(
  tier = NULL,
  division = NULL,
  region = self$region,
  dry_run = self$dry_run
)

---

Method by_leagueId()

Usage

tft_league$by_leagueId(leagueId, region = self$region, dry_run = self$dry_run)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

tft_league$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

its-gazza/riotR documentation built on July 12, 2020, 12:06 a.m.