Interface IRiotGamesApiConfig

Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public interface IRiotGamesApiConfig

Properties

| Improve this Doc View Source

ApiKey

Riot Games API key.

Declaration
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
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
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
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
float ConcurrentInstanceFactor { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxConcurrentRequests

Maximum number of concurrent requests allowed.

Declaration
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
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
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
string RouteKey { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TokenBucketFactory

Factory for creating token buckets.

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