Show / Hide Table of Contents

Class StaticRiotApi

Entry point for the static API.

Inheritance
System.Object
StaticRiotApi
Namespace:RiotSharp
Assembly:RiotSharp.dll
Syntax
public class StaticRiotApi : object, IStaticRiotApi

Methods

GetChampion(Region, Int32, ChampionData, Language)

Get a champion synchronously.

Declaration
public ChampionStatic GetChampion(Region region, int championId, ChampionData championData = ChampionData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 championId

Id of the champion to retrieve.

ChampionData championData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
ChampionStatic

A champion.

Implements
IStaticRiotApi.GetChampion(Region, Int32, ChampionData, Language)

GetChampionAsync(Region, Int32, ChampionData, Language)

Get a champion asynchronously.

Declaration
public Task<ChampionStatic> GetChampionAsync(Region region, int championId, ChampionData championData = ChampionData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 championId

Id of the champion to retrieve.

ChampionData championData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><ChampionStatic>

A champion.

Implements
IStaticRiotApi.GetChampionAsync(Region, Int32, ChampionData, Language)

GetChampions(Region, ChampionData, Language)

Get a list of all champions synchronously.

Declaration
public ChampionListStatic GetChampions(Region region, ChampionData championData = ChampionData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

ChampionData championData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
ChampionListStatic

A ChampionListStatic object containing all champions.

Implements
IStaticRiotApi.GetChampions(Region, ChampionData, Language)

GetChampionsAsync(Region, ChampionData, Language)

Get a list of all champions asynchronously.

Declaration
public Task<ChampionListStatic> GetChampionsAsync(Region region, ChampionData championData = ChampionData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

ChampionData championData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><ChampionListStatic>

A ChampionListStatic object containing all champions.

Implements
IStaticRiotApi.GetChampionsAsync(Region, ChampionData, Language)

GetInstance(String)

Get the instance of StaticRiotApi.

Declaration
public static StaticRiotApi GetInstance(string apiKey)
Parameters
Type Name Description
System.String apiKey

The api key.

Returns
Type Description
StaticRiotApi

The instance of StaticRiotApi.

GetItem(Region, Int32, ItemData, Language)

Get an item synchronously.

Declaration
public ItemStatic GetItem(Region region, int itemId, ItemData itemData = ItemData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 itemId

Id of the item to retrieve.

ItemData itemData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
ItemStatic

An item.

Implements
IStaticRiotApi.GetItem(Region, Int32, ItemData, Language)

GetItemAsync(Region, Int32, ItemData, Language)

Get an item asynchronously.

Declaration
public Task<ItemStatic> GetItemAsync(Region region, int itemId, ItemData itemData = ItemData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 itemId

Id of the item to retrieve.

ItemData itemData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><ItemStatic>

An item.

Implements
IStaticRiotApi.GetItemAsync(Region, Int32, ItemData, Language)

GetItems(Region, ItemData, Language)

Get a list of all items synchronously.

Declaration
public ItemListStatic GetItems(Region region, ItemData itemData = ItemData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

ItemData itemData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
ItemListStatic

An ItemListStatic object containing all items.

Implements
IStaticRiotApi.GetItems(Region, ItemData, Language)

GetItemsAsync(Region, ItemData, Language)

Get a list of all items synchronously.

Declaration
public Task<ItemListStatic> GetItemsAsync(Region region, ItemData itemData = ItemData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

ItemData itemData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><ItemListStatic>

An ItemListStatic object containing all items.

Implements
IStaticRiotApi.GetItemsAsync(Region, ItemData, Language)

GetLanguages(Region)

Get languages synchronously.

Declaration
public List<Language> GetLanguages(Region region)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Returns
Type Description
List<><Language>

A list of languages.

Implements
IStaticRiotApi.GetLanguages(Region)

GetLanguagesAsync(Region)

Get languages asynchronously.

Declaration
public Task<List<Language>> GetLanguagesAsync(Region region)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Returns
Type Description
Task<><List<><Language>>

A list of languages.

Implements
IStaticRiotApi.GetLanguagesAsync(Region)

GetLanguageStrings(Region, Language, String)

Retrieve language strings synchronously.

Declaration
public LanguageStringsStatic GetLanguageStrings(Region region, Language language = Language.en_US, string version = "")
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Language language

Language of the data to be retrieved.

System.String version

Version of the dragon API.

Returns
Type Description
LanguageStringsStatic

A object containing the language strings.

Implements
IStaticRiotApi.GetLanguageStrings(Region, Language, String)

GetLanguageStringsAsync(Region, Language, String)

Retrieve language strings asynchronously.

Declaration
public Task<LanguageStringsStatic> GetLanguageStringsAsync(Region region, Language language = Language.en_US, string version = "")
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Language language

Language of the data to be retrieved.

System.String version

Version of the dragon API.

Returns
Type Description
Task<><LanguageStringsStatic>

A object containing the language strings.

Implements
IStaticRiotApi.GetLanguageStringsAsync(Region, Language, String)

GetMaps(Region, Language, String)

Get maps synchronously.

Declaration
public List<MapStatic> GetMaps(Region region, Language language = Language.en_US, string version = "")
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Language language

Language of the data to be retrieved.

System.String version

Version of the dragon API.

Returns
Type Description
List<><MapStatic>

A list of objects representing maps.

Implements
IStaticRiotApi.GetMaps(Region, Language, String)

GetMapsAsync(Region, Language, String)

Get maps asynchronously.

Declaration
public Task<List<MapStatic>> GetMapsAsync(Region region, Language language = Language.en_US, string version = "")
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

Language language

Language of the data to be retrieved.

System.String version

Version of the dragon API.

Returns
Type Description
Task<><List<><MapStatic>>

A list of objects representing maps.

Implements
IStaticRiotApi.GetMapsAsync(Region, Language, String)

GetMasteries(Region, MasteryData, Language)

Get a list of all masteries synchronously.

Declaration
public MasteryListStatic GetMasteries(Region region, MasteryData masteryData = MasteryData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

MasteryData masteryData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
MasteryListStatic

An MasteryListStatic object containing all masteries.

Implements
IStaticRiotApi.GetMasteries(Region, MasteryData, Language)

GetMasteriesAsync(Region, MasteryData, Language)

Get a list of all masteries asynchronously.

Declaration
public Task<MasteryListStatic> GetMasteriesAsync(Region region, MasteryData masteryData = MasteryData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

MasteryData masteryData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><MasteryListStatic>

An MasteryListStatic object containing all masteries.

Implements
IStaticRiotApi.GetMasteriesAsync(Region, MasteryData, Language)

GetMastery(Region, Int32, MasteryData, Language)

Get a mastery synchronously.

Declaration
public MasteryStatic GetMastery(Region region, int masteryId, MasteryData masteryData = MasteryData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 masteryId

Id of the mastery to retrieve.

MasteryData masteryData

Data to retrieve.

Language language

Language of th data to be retrieved.

Returns
Type Description
MasteryStatic

A mastery.

Implements
IStaticRiotApi.GetMastery(Region, Int32, MasteryData, Language)

GetMasteryAsync(Region, Int32, MasteryData, Language)

Get a mastery asynchronously.

Declaration
public Task<MasteryStatic> GetMasteryAsync(Region region, int masteryId, MasteryData masteryData = MasteryData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 masteryId

Id of the mastery to retrieve.

MasteryData masteryData

Data to retrieve.

Language language

Language of th data to be retrieved.

Returns
Type Description
Task<><MasteryStatic>

A mastery.

Implements
IStaticRiotApi.GetMasteryAsync(Region, Int32, MasteryData, Language)

GetRealm(Region)

Retrieve realm data synchronously.

Declaration
public RealmStatic GetRealm(Region region)
Parameters
Type Name Description
Region region

Region corresponding to data to retrieve.

Returns
Type Description
RealmStatic

A realm object containing the requested information.

Implements
IStaticRiotApi.GetRealm(Region)

GetRealmAsync(Region)

Retrieve realm data asynchronously.

Declaration
public Task<RealmStatic> GetRealmAsync(Region region)
Parameters
Type Name Description
Region region

Region corresponding to data to retrieve.

Returns
Type Description
Task<><RealmStatic>

A realm object containing the requested information.

Implements
IStaticRiotApi.GetRealmAsync(Region)

GetRune(Region, Int32, RuneData, Language)

Get a rune synchronously.

Declaration
public RuneStatic GetRune(Region region, int runeId, RuneData runeData = RuneData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 runeId

Id of the rune to retrieve.

RuneData runeData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
RuneStatic

A rune.

Implements
IStaticRiotApi.GetRune(Region, Int32, RuneData, Language)

GetRuneAsync(Region, Int32, RuneData, Language)

Get a rune asynchronously.

Declaration
public Task<RuneStatic> GetRuneAsync(Region region, int runeId, RuneData runeData = RuneData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

System.Int32 runeId

Id of the rune to retrieve.

RuneData runeData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><RuneStatic>

A rune.

Implements
IStaticRiotApi.GetRuneAsync(Region, Int32, RuneData, Language)

GetRunes(Region, RuneData, Language)

Get a list of all runes synchronously.

Declaration
public RuneListStatic GetRunes(Region region, RuneData runeData = RuneData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

RuneData runeData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
RuneListStatic

A RuneListStatic object containing all runes.

Implements
IStaticRiotApi.GetRunes(Region, RuneData, Language)

GetRunesAsync(Region, RuneData, Language)

Get a list of all runes asynchronously.

Declaration
public Task<RuneListStatic> GetRunesAsync(Region region, RuneData runeData = RuneData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

RuneData runeData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><RuneListStatic>

A RuneListStatic object containing all runes.

Implements
IStaticRiotApi.GetRunesAsync(Region, RuneData, Language)

GetSummonerSpell(Region, SummonerSpell, SummonerSpellData, Language)

Get a summoner spell synchronously.

Declaration
public SummonerSpellStatic GetSummonerSpell(Region region, SummonerSpell summonerSpell, SummonerSpellData summonerSpellData = SummonerSpellData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

SummonerSpell summonerSpell

Summoner spell to retrieve.

SummonerSpellData summonerSpellData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
SummonerSpellStatic

A summoner spell.

Implements
IStaticRiotApi.GetSummonerSpell(Region, SummonerSpell, SummonerSpellData, Language)

GetSummonerSpellAsync(Region, SummonerSpell, SummonerSpellData, Language)

Get a summoner spell asynchronously.

Declaration
public Task<SummonerSpellStatic> GetSummonerSpellAsync(Region region, SummonerSpell summonerSpell, SummonerSpellData summonerSpellData = SummonerSpellData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

SummonerSpell summonerSpell

Summoner spell to retrieve.

SummonerSpellData summonerSpellData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><SummonerSpellStatic>

A summoner spell.

Implements
IStaticRiotApi.GetSummonerSpellAsync(Region, SummonerSpell, SummonerSpellData, Language)

GetSummonerSpells(Region, SummonerSpellData, Language)

Get a list of all summoner spells synchronously.

Declaration
public SummonerSpellListStatic GetSummonerSpells(Region region, SummonerSpellData summonerSpellData = SummonerSpellData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

SummonerSpellData summonerSpellData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
SummonerSpellListStatic

A SummonerSpellListStatic object containing all summoner spells.

Implements
IStaticRiotApi.GetSummonerSpells(Region, SummonerSpellData, Language)

GetSummonerSpellsAsync(Region, SummonerSpellData, Language)

Get a list of all summoner spells asynchronously.

Declaration
public Task<SummonerSpellListStatic> GetSummonerSpellsAsync(Region region, SummonerSpellData summonerSpellData = SummonerSpellData.basic, Language language = Language.en_US)
Parameters
Type Name Description
Region region

Region from which to retrieve the data.

SummonerSpellData summonerSpellData

Data to retrieve.

Language language

Language of the data to be retrieved.

Returns
Type Description
Task<><SummonerSpellListStatic>

A SummonerSpellListStatic object containing all summoner spells.

Implements
IStaticRiotApi.GetSummonerSpellsAsync(Region, SummonerSpellData, Language)

GetVersions(Region)

Retrieve static api version data synchronously.

Declaration
public List<string> GetVersions(Region region)
Parameters
Type Name Description
Region region

Region from which to retrieve data.

Returns
Type Description
List<><System.String>

A list of versions as strings.

Implements
IStaticRiotApi.GetVersions(Region)

GetVersionsAsync(Region)

Retrieve static api version data asynchronously.

Declaration
public Task<List<string>> GetVersionsAsync(Region region)
Parameters
Type Name Description
Region region

Region from which to retrieve data.

Returns
Type Description
Task<><List<><System.String>>

A list of versions as strings.

Implements
IStaticRiotApi.GetVersionsAsync(Region)
Back to top Copyright © 2015-2016 Microsoft
Generated by DocFX