Show / Hide Table of Contents

Class RiotGamesApiConfig

Inheritance
System.Object
RiotGamesApiConfig
Implements
IRiotGamesApiConfig
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public class RiotGamesApiConfig : IRiotGamesApiConfig

Properties

| Improve this Doc View Source

ApiKey

Riot Games API key.

Declaration
public string ApiKey { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ApiRouteConfig

How the API call should include the region/route.

Declaration
public RouteConfig ApiRouteConfig { get; }
Property Value
Type Description
RouteConfig
| Improve this Doc View Source

ApiUrl

URL to call for the Riot Games API. Include {0} for the region/route, if you want it in the URL - Not necessary if apiCallRouteConfig is RouteConfig.InUrlAsRouteQueryParameter.

Declaration
public string ApiUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

BackoffStrategy

A backoff strategy for 429s with missing Retry-After headers. Returns seconds.

Declaration
public BackoffStrategy BackoffStrategy { get; }
Property Value
Type Description
BackoffStrategy
| Improve this Doc View Source

ConcurrentInstanceFactor

Multiplier for using concurrent instances. For example, use 0.25 for 4 concurrent instances equally spread.

Declaration
public float ConcurrentInstanceFactor { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxConcurrentRequests

Maximum number of concurrent requests allowed.

Declaration
public int MaxConcurrentRequests { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

OverheadFactor

Overhead factor to reduce the chance 429s due to network noise.

Declaration
public float OverheadFactor { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Retries

Number of times to retry a failed request (zero for no retries).

Declaration
public int Retries { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RouteKey

The query or header name to use for the region/route. Only used if RouteConfig is set to InHeader or InQueryParam.

Declaration
public string RouteKey { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TokenBucketFactory

Factory for creating token buckets.

Declaration
public TokenBucketFactory TokenBucketFactory { get; }
Property Value
Type Description
TokenBucketFactory

Implements

IRiotGamesApiConfig
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX