Angel class - angel_client library

Constructors

Angel(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. [...]
read / write
basePath → String: Prefer to use baseUrl instead.
read-only
baseUrl → Uri: The root URL at which the target server.
final
hashCode → int: The hash code for this object. [...]
read-only, inherited
onAuthenticated → Stream<AngelAuthResult>: Fired whenever a WebSocket is successfully authenticated.
read-only
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited

Methods

authenticate({String type, dynamic credentials, String authEndpoint = '/auth', String reviveEndpoint = '/auth/token'}) → Future<AngelAuthResult>: Authenticates against the server. [...]
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.
close() → Future<void>: Disposes of any outstanding resources.
configure(AngelConfigurer configurer) → Future<void>: Applies an AngelConfigurer to this instance.
delete(dynamic url, {Map<String, String> headers}) → Future<Response>: Sends an HTTP DELETE request with the given headers to the given URL, which can be a Uri or a String. [...]
get(dynamic url, {Map<String, String> headers}) → Future<Response>: Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String. [...]
head(dynamic url, {Map<String, String> headers}) → Future<Response>: Sends an HTTP HEAD request with the given headers to the given URL, which can be a Uri or a String. [...]
logout() → FutureOr<void>: Logs the current user out of the application.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed. [...]
inherited
patch(dynamic url, {dynamic body, Map<String, String> headers, Encoding encoding}) → Future<Response>: Sends an HTTP PATCH request with the given headers and body to the given URL, which can be a Uri or a String. [...]
post(dynamic url, {dynamic body, Map<String, String> headers, Encoding encoding}) → Future<Response>: Sends an HTTP POST request with the given headers and body to the given URL, which can be a Uri or a String. [...]
put(dynamic url, {dynamic body, Map<String, String> headers, Encoding encoding}) → Future<Response>: Sends an HTTP PUT request with the given headers and body to the given URL, which can be a Uri or a String. [...]
read(dynamic url, {Map<String, String> headers}) → Future<String>: Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String, and returns a Future that completes to the body of the response as a String. [...]
inherited
readBytes(dynamic url, {Map<String, String> headers}) → Future<Uint8List>: Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String, 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.
send(BaseRequest request) → Future<StreamedResponse>: Sends an HTTP request and asynchronously returns the response. [...]
inherited
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. [...]
toString() → String: Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator. [...]
inherited