RestBloc class

RestBloc - A bloc to make request to a REST API

GET, POST, PUT, PATCH, DELETE available

Constructors

RestBloc(String baseUrl, {List<Interceptor>? interceptors})

Main constructor

Properties

currentBaseUrl ↔ String

Get current base url

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isClosed → bool

Whether the bloc is closed.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state → RestState

The current state.

no setter, inherited

stream → Stream<RestState>

The current stream of states.

no setter, inherited

Methods

add(RestEvent event) → void

Notifies the Bloc of a new event which triggers all corresponding EventHandler instances.

inherited

addError(Object error, [StackTrace? stackTrace]) → void

Reports an error which triggers onError with an optional StackTrace.

inherited

clear() → void

Clear RestState

close() → Future<void>

Closes the event and state Streams. This method should be called when a Bloc is no longer needed. Once close is called, events that are added will not be processed. In addition, if close is called while events are still being processed, the Bloc will finish processing the pending events.

inherited

delete(String path, {Map<String, String>? headers, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?}) → void

DELETE request to API

emit(RestState state) → void

emit is only for internal use and should never be called directly outside of tests. The Emitter instance provided to each EventHandler should be used instead.

inherited

formData(String path, {required FormData body, Map<String, String>? headers, String? contentType, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?, void onProgressChanged(int, int)?}) → void

POST request with FormData content.

get(String path, {Map<String, String>? headers, Map<String, String>? params, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?}) → void

GET request to API

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

on<E extends Event>(EventHandler<E, RestState> handler, {EventTransformer<E>? transformer}) → void

Register event handler for an event of type E. There should only ever be one event handler per event type E.

inherited

onChange(Change<RestState> change) → void

Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.

inherited

onError(Object error, StackTrace stackTrace) → void

Called whenever an error occurs and notifies BlocObserver.onError.

inherited

onEvent(RestEvent event) → void

Called whenever an event is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.

inherited

onTransition(Transition<RestEvent, RestState> transition) → void

Called whenever a transition occurs with the given transition. A transition occurs when a new event is added and a new state is emitted from a corresponding EventHandler.

inherited

patch(String path, {Map<String, String>? headers, Map<String, dynamic>? body, String? contentType, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?}) → void

PATCH request to API

post(String path, {Map<String, String>? headers, Map<String, dynamic>? body, String? contentType, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?}) → void

POST request to API

put(String path, {Map<String, String>? headers, Map<String, dynamic>? body, String? contentType, bool withLoading = true, dynamic fromJson(Map<String, dynamic>)?}) → void

PUT request to API

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited