ShadertoyWSOptions class
Options for the Shadertoy REST API client
Stores the options used to build a ShadertoyWSClient
- Inheritance
-
- Object
- ShadertoyHttpOptions
- ShadertoyWSOptions
Constructors
- ShadertoyWSOptions({required String apiKey, String? apiPath, String? baseUrl, int? poolMaxAllocatedResources, int? poolTimeout, int? retryMaxAttempts, int? shaderCount, ErrorMode? errorHandling})
- Builds a ShadertoyWSOptions
Properties
- apiKey → String
-
The API key that should be appended for each call
final
- apiPath → String
-
The configured API path
final
- baseUrl → String
-
The base url of the shadertoy website
finalinherited
- errorHandling → ErrorMode
-
The selected error handling mode
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- poolMaxAllocatedResources → int
-
The maximum number of resources that may be allocated at once in the pool
finalinherited
- poolTimeout → int
-
Constrains the maximum time a call to the Shadertoy API can last. If this
value is exceed an exception is thrown for the offending request and for all
the others in the queue
finalinherited
- retryMaxAttempts → int
-
The maximum number of atempts before giving up.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shaderCount → int
-
The number of shaders fetched for paged call
finalinherited
- supportsCookies → bool
-
If the http client supports cookies
finalinherited
Methods
-
copyWith(
{String? apiKey, String? apiPath, String? baseUrl, int? poolMaxAllocatedResources, int? poolTimeout, int? retryMaxAttempts, int? shaderCount, ErrorMode? errorHandling}) → ShadertoyWSOptions - Builds a copy of a ShadertoyWSOptions
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- defaultApiPath → const String
- The default base API path to use for the REST calls