AuthenticatedApi class abstract
- Inheritance
- Implementers
Constructors
- AuthenticatedApi(String identifier, {Client? client, Converter? converter, AuthStorage? authStorage})
Properties
- baseUrl ↔ String?
-
getter/setter pairinherited
- converter ↔ Converter?
-
getter/setter pairinherited
- currentAccount ↔ Account?
-
getter/setter pair
-
defaultHeaders
↔ Map<
String, String> ? -
getter/setter pairinherited
- defaultMediaType ↔ String
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpClient → Client
-
finalinherited
- identifier → String?
-
finalinherited
- jsonConverter → JsonConverter
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useragent ↔ String?
-
getter/setter pairinherited
Methods
-
authenticate(
) → Future< Account?> - Call this method to get the Authenticated user.
-
authenticateRequest(
Request request) → Future< Request> - Called internally to apply the credentials to a request
-
decodeResponse<
Value> (Response< String?> response, Type responseType, bool responseIsList) → Future<Response< Value?> > -
Used to decode the response body before returning from an API call
inherited
-
encodeRequest(
Request request) → Future< Request> -
Used to encode the body of the request before sending it.
inherited
-
getAccountFromMap<
T extends Account> (Map< String, dynamic> data) → dynamic -
interceptRequest(
Request request) → Future< Request> -
Called before a request is sent across the wire.
override
-
interceptResponse(
Response response) → Future< Response> -
Called before the response is returned to the user
inherited
-
loadAccountFromCache<
T extends Account> () → Future< T?> - This should not be called, it is used to cache the account locally
-
logOut(
) → Future -
Log the user out
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
performAuthenticate(
) → Future< Account?> - This method is for subclasses only. Call authenticate() instead.
-
ping(
) → Future< bool> -
inherited
-
pingUrl(
String url) → Future< bool> -
inherited
-
refreshAccount(
Account account) → Future -
saveAccountToCache(
Account account) → Future - This should not be called, it is used to cache the account locally
-
send<
Value> (Request request, {Type? responseType, bool responseIsList = false}) → Future< Response< Value?> > -
Used to send a request
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
verifyCredentials(
) → Future< bool> - Called to determine if the current credentials are valid.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited