AuthOptions class
Passes authentication-specific properties in authentication requests to Ably.
Properties set using AuthOptions are used instead of the default
values set when the client library is instantiated, as opposed to being
merged with them.
- Implementers
Properties
- authCallback ↔ AuthCallback?
-
Called when a new token is required.
getter/setter pair
-
authHeaders
↔ Map<
String, String> ? -
A set of key-value pair headers to be added to any request made to the
authUrl.getter/setter pair - authMethod ↔ String?
-
The HTTP verb to use for any request made to the
authUrl, eitherGETorPOST.getter/setter pair -
authParams
↔ Map<
String, String> ? -
A set of key-value pair params to be added to any request made to the
authUrl.getter/setter pair - authUrl ↔ String?
-
A URL that the library may use to obtain a token string (in plain text
format), or a signed TokenRequest or TokenDetails (in JSON format)
from.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- key ↔ String?
-
The full API key string, as obtained from the Ably dashboard.
getter/setter pair
- queryTime ↔ bool?
-
Whether the library queries the Ably servers for the current time when
issuing TokenRequests instead of relying on a locally-available time of
day.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- tokenDetails ↔ TokenDetails?
-
An authenticated TokenDetails object (most commonly obtained from an
Ably Token Request response).
getter/setter pair
- useTokenAuth ↔ bool?
-
Whether library is forced to use token authentication.
getter/setter pair
Methods
-
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