Rest class

Queries an Angel server via REST.

Inheritance

Constructors

Rest(String path)

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

Methods

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.
override
close() → Future
Disposes of any outstanding resources.
override
service<Id, Data>(String path, { Type type, AngelDeserializer deserializer }) Service<Id, Data>
Creates a Service instance that queries a given path on the server. [...]
override
authenticate({String type, dynamic credentials, String authEndpoint: '/auth', String reviveEndpoint: '/auth/token' }) → Future<AngelAuthResult>
Authenticates against the server. [...]
inherited
configure(AngelConfigurer configurer) → Future<void>
Applies an AngelConfigurer to this instance.
inherited
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. [...]
inherited
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. [...]
inherited
Sends an HTTP HEAD request with the given headers to the given URL, which can be a Uri or a String. [...]
inherited
logout() → Future<void>
Logs the current user out of the application.
inherited
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. [...]
inherited
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. [...]
inherited
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. [...]
inherited
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.
inherited
send(BaseRequest request) → Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response. [...]
inherited
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.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

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