Contains settings for a RiotClient.
More...
|
| string | ApiKey [get, set] |
| | Gets or sets the Riot API key to use. NOTE: If you are using a public repository, do NOT check you API key in to the repository. It is recommended to load your API key from a separate file (e.g. key.txt) that is ignored by your repository. More...
|
| |
| bool | UseTournamentStub [get, set] |
| | Gets or sets whether to use the tournament-stub API instead of the tournament API. More...
|
| |
| bool | RetryOnTimeout = false [get, set] |
| | Gets or sets how the RiotClient should handle the case where the request times out. More...
|
| |
| bool | RetryOnConnectionFailure = false [get, set] |
| | Gets or sets how the RiotClient should handle the case where the client fails to connect to the server. More...
|
| |
| bool | RetryOnRateLimitExceeded = false [get, set] |
| | Gets or sets how the RiotClient should handle the case where the rate limit is exceeded. More...
|
| |
| bool | RetryOnServerError = true [get, set] |
| | Gets or sets how the RiotClient should handle the case where server returns an error code of 500 or higher. More...
|
| |
| bool | ThrowOnError = true [get, set] |
| | Gets or sets whether the client should throw an exception if an error occurred during the request (that is, the request did not complete, or it completed with a response code of 400 or higher, except for 404 errors). More...
|
| |
| bool | ThrowOnNotFound = true [get, set] |
| | Gets or sets whether the client should throw an exception if the server responded with a Not Found (404) error. More...
|
| |
| int | MaxRequestAttempts = false [get, set] |
| | Gets or sets the maximum number of times that the same request should be attempted. Applies only if one of the RequestErrorHandling modes is set to Retry. More...
|
| |
Contains settings for a RiotClient.
| RiotNet.RiotClientSettings.RiotClientSettings |
( |
| ) |
|
|
inline |
| string RiotNet.RiotClientSettings.ApiKey |
|
getset |
Gets or sets the Riot API key to use. NOTE: If you are using a public repository, do NOT check you API key in to the repository. It is recommended to load your API key from a separate file (e.g. key.txt) that is ignored by your repository.
| int RiotNet.RiotClientSettings.MaxRequestAttempts = false |
|
getset |
Gets or sets the maximum number of times that the same request should be attempted. Applies only if one of the RequestErrorHandling modes is set to Retry.
| bool RiotNet.RiotClientSettings.RetryOnConnectionFailure = false |
|
getset |
Gets or sets how the RiotClient should handle the case where the client fails to connect to the server.
| bool RiotNet.RiotClientSettings.RetryOnRateLimitExceeded = false |
|
getset |
Gets or sets how the RiotClient should handle the case where the rate limit is exceeded.
| bool RiotNet.RiotClientSettings.RetryOnServerError = true |
|
getset |
Gets or sets how the RiotClient should handle the case where server returns an error code of 500 or higher.
This is true by default because it seems that the Riot Games API intermittently returns 50x response codes. This can be resolved by re-sending the request.
| bool RiotNet.RiotClientSettings.RetryOnTimeout = false |
|
getset |
Gets or sets how the RiotClient should handle the case where the request times out.
| bool RiotNet.RiotClientSettings.ThrowOnError = true |
|
getset |
Gets or sets whether the client should throw an exception if an error occurred during the request (that is, the request did not complete, or it completed with a response code of 400 or higher, except for 404 errors).
| bool RiotNet.RiotClientSettings.ThrowOnNotFound = true |
|
getset |
Gets or sets whether the client should throw an exception if the server responded with a Not Found (404) error.
| bool RiotNet.RiotClientSettings.UseTournamentStub |
|
getset |
Gets or sets whether to use the tournament-stub API instead of the tournament API.
The documentation for this class was generated from the following file:
1.8.10
