SpongeRestClientConfiguration class

A Sponge REST API configuration.

Constructors

SpongeRestClientConfiguration(String url, { String username, String password, bool useRequestId: false, bool autoUseAuthToken: false, bool relogin: true, bool verifyProcessorVersion: true, bool useActionMetaCache: true, int actionMetaCacheMaxSize: -1, bool throwExceptionOnErrorResponse: true })

Properties

actionMetaCacheMaxSize ↔ int
The maximum size of the action meta cache. The default value (-1) implies that there is no maximum size.
read / write
autoUseAuthToken ↔ bool
The flag telling if the client should automatically use auth token authentication (i.e. the login operation won't be required to use the auth token authentication). Defaults to false.
read / write
password ↔ String
The optional service user name.
read / write
relogin ↔ bool
The flag telling if the client should automatically relogin when an auth token expires.
read / write
secure → bool
Returns true if the connection URL is HTTPS.
read-only
throwExceptionOnErrorResponse ↔ bool
The flag that instructs the client to throw an exception when a response is an error response. Defaults to true. Setting this value to false makes sense only when using the client API methods *ByRequest().
read / write
url ↔ String
The service URL (reqired).
read / write
useActionMetaCache ↔ bool
The flag telling if the client should use the action meta cache.
read / write
useRequestId ↔ bool
The flag telling if the client should use a request ID for all requests.
read / write
username ↔ String
The optional service user name.
read / write
verifyProcessorVersion ↔ bool
The flag telling if the client should request verification of a processor version on the server.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited