BaseAngelClient class abstract

Inheritance

• Object
• Angel
• BaseAngelClient

Implementers

• Rest
• Rest
• Rest

Constructors

BaseAngelClient.new(BaseClient client, dynamic baseUrl)

Properties

authToken ↔ String?

A mutable member. When this is set, it holds a JSON Web Token that is automatically attached to every request sent.

getter/setter pair, inherited

baseUrl → Uri

The root URL at which the target server.

final, inherited

client → BaseClient

final

hashCode → int

The hash code for this object.

no setter, inherited

onAuthenticated → Stream<AngelAuthResult>

Fired whenever a WebSocket is successfully authenticated.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

authenticate({String? type, dynamic credentials, String authEndpoint = '/auth'}) → Future<AngelAuthResult>

Authenticates against the server.

override

authenticateViaPopup(String url, {String eventName = 'token'}) → Stream<String>

Opens the url in a new window, and returns a Stream that will fire a JWT on successful authentication.

inherited

close() → Future<void>

Disposes of any outstanding resources.

override

configure(AngelConfigurer configurer) → Future<void>

Applies an AngelConfigurer to this instance.

inherited

delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>

Sends an HTTP DELETE request with the given headers to the given URL.

inherited

get(Uri url, {Map<String, String>? headers}) → Future<Response>

Sends an HTTP GET request with the given headers to the given URL.

override

head(Uri url, {Map<String, String>? headers}) → Future<Response>

Sends an HTTP HEAD request with the given headers to the given URL.

override

logout() → Future<void>

Logs the current user out of the application.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) → Future<Response>

Sends an HTTP PATCH request with the given headers and body to the given URL.

override

post(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) → Future<Response>

Sends an HTTP POST request with the given headers and body to the given URL.

override

put(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) → Future<Response>

Sends an HTTP PUT request with the given headers and body to the given URL.

override

read(Uri url, {Map<String, String>? headers}) → Future<String>

Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.

inherited

readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>

Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.

inherited

reviveJwt(String token, {String authEndpoint = '/auth'}) → Future<AngelAuthResult>

Shorthand for authenticating via a JWT string.

inherited

send(BaseRequest request) → Future<StreamedResponse>

Sends an HTTP request and asynchronously returns the response.

sendUnstreamed(String method, dynamic url, Map<String, String>? headers, [dynamic body, Encoding? encoding]) → Future<Response>

Sends a non-streaming Request and returns a non-streaming Response.

service<Id, Data>(String path, {Type? type, AngelDeserializer<Data>? deserializer}) → Service<Id, Data>

Creates a Service instance that queries a given path on the server.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited