APIDBModule class
Methods
-
acceptsRequest(APIRequest apiRequest)
→ bool
-
Returns
true
if apiRequest
is an accepted route/call for this module.
inherited
-
addRoute(APIRequestMethod? method, String name, APIRouteFunction function, {Map<String, TypeInfo>? parameters, Iterable<APIRouteRule>? rules, APIRouteConfig? config})
→ APIModule
-
Adds a route, of
name
, to this module.
inherited
-
apiInfo([APIRequest? apiRequest])
→ APIModuleInfo
-
Returns a APIModuleInfo.
inherited
-
call<T>(APIRequest request)
→ FutureOr<APIResponse<T>>
-
Calls a route for
request
.
inherited
-
checkAuthentication(APIRequest request)
→ Future<APIResponse<Object>?>
-
-
checkInitialized()
→ void
-
Checks if this instance is initialized.
inherited
-
configure()
→ void
-
Configures this API module. Usually defines the routes of this instance.
override
-
delete(String table, APIRequest apiRequest, Object? id)
→ Future<APIResponse<String>>
-
-
doInitialization({Initializable? parent})
→ FutureOr<InitializationResult>
-
Initialize this instance if is not initialized yet.
inherited
-
dump(bool zip)
→ Future<APIResponse<Object>>
-
-
ensureConfigured()
→ void
-
inherited
-
ensureInitialized({Initializable? parent})
→ FutureOr<InitializationResult>
-
Ensures that this instance is initialized.
inherited
-
ensureInitializedAsync({Initializable? parent})
→ FutureOr<InitializationResult>
-
Ensures that this instance is initialized. If is not
initialized yet it will force an asynchronous initialization
and return a Future.
inherited
-
executeInitialized<R>(ExecuteInitializedCallback<R> callback, {Initializable? parent})
→ FutureOr<R>
-
Executes the
callback
ensuring that this instances was fully initialized.
inherited
-
getRouteHandler<T>(String name, [APIRequestMethod? method])
→ APIRouteHandler<T>?
-
Returns a route handler for
name
.
inherited
-
getRouteHandlerByRequest<T>(APIRequest request, [String? routeName])
→ APIRouteHandler<T>?
-
Returns a route handler for
request
.
inherited
-
getRoutesHandlersNames({APIRequestMethod? method})
→ Iterable<String>
-
Returns the routes names for
method
.
inherited
-
initialize()
→ FutureOr<InitializationResult>
-
Initialization implementation. Do not call it directly, use doInitialization.
inherited
-
initializeDependencies()
→ FutureOr<List<Initializable>>
-
Return a List of Initializable instances that need to be initialized
BEFORE initialize this instance.
inherited
-
insert(String table, APIRequest apiRequest, {Object? id})
→ Future<APIResponse<String>>
-
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveRoute(APIRequest request)
→ String
-
Resolves the route name of the
request
.
inherited
-
select(String table, APIRequest apiRequest, {bool? eager, bool json = false})
→ Future<APIResponse>
-
-
tables({bool json = false})
→ Future<APIResponse>
-
-
toString()
→ String
-
A string representation of this object.
inherited