ApiRest class

Available extensions

Constructors

ApiRest({required CloudDb cloudDb, required ModeToWork modeToWork, required GestorData gestorData, required String coleccionFuncionesBackend, bool enableDebugLogs = false})
factory

Properties

cloudDb → CloudDb
final
coleccionFuncionesBackend → String
final
enableDebugLogs → bool
final
gestorData → GestorData
final
hashCode → int
The hash code for this object.
no setterinherited
modeToWork → ModeToWork
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

actualizar<T extends ColeccionBase>({required T data, required String versionData, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo, ModeToWork? modeToWork, String idFuncionBackend = '', Map<String, dynamic>? dataAdicionalBody}) → Future<Map<String, dynamic>>
Funcion utilizada para actualiza un registro data - es una clase de tipo ColeccionObjBox que contiene los datos a actualizar versionData - es la version de la coleccion que se va actualizar
cambiaEstado<T extends ColeccionBase>({required String coleccion, required String id, required String estado, QueryPropertiesWrapper<T>? queryPropertiesWrapper, bool? runIsolate, String? tipoId}) → Future<Map<String, dynamic>>
Funcion utilizada para actualizar el estodo de un registro coleccion - es la coleccion que se quiere leer id - es el id del registro que se quiere actualizar. Si se esta trabajando en modo offline se debe pasar el idMobile y si se esta trabajando en modo online se debe pasar el idServer estado - es el estado que se le quiere asignar al registro queryPropertiesWrapper - es un objeto que contiene las propiedades de la consulta runIsolate - es un booleano que indica si se debe ejecutar en un isolate tipoId - es el tipo de id que se esta pasando si es idMobile o idServer este ultimo parametro es utilizado solo para mantener la comparibilidad con la rama rm
downLoadInfoFromServer<T extends ColeccionBase>({required String coleccion, String? consulta, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo}) → Future<Map<String, dynamic>>
guardar<T extends ColeccionBase>({required T data, required String versionData, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo, ModeToWork? modeToWork, String idFuncionBackend = '', Map<String, dynamic>? dataAdicionalBody}) → Future<Map<String, dynamic>>
Funcion utilizada para actualiza un registro data - clase ColeccionObjBox la cual contiene los datos a guardar versionData - es la version de la coleccion que se va actualizar Ejemplo para generar un nuevo Ciudadano:
init({bool storeInMemoryObjecBox = false, String? urlAdminObjectBox, int? maxDBSizeInKB}) → Future<void>
Los parametros que recibe esta funcion son utilizados por el gestor de datos ObjectBox y por lo tanto son requeridos si asi fuera el caso en la rama rw de api_rest_flutter
leeById<T extends ColeccionBase>({required String coleccion, required String consulta, required List<List<String>> argsLocalBD, QueryPropertiesWrapper<T>? queryPropertiesWrapper, ModeToWork? modeToWork, T? modelo}) → Future<Map<String, dynamic>>
Funcion utilizada para leer un registro x su id o alguna clave unica
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
obtener<T extends ColeccionBase>({required String coleccion, required String consulta, required List<List<String>> argsLocalBD, Map<String, dynamic>? project, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo, String? ordenar, String? limit, String? skip, List<String>? union, String? concatenar, bool? runIsolate, ModeToWork? modeToWork}) → Future<Map<String, dynamic>>
Funcion utilizada para obtener un lista de registros de una coleccion determinada consulta - es la consulta que se va a ejecutar en el servidor debe respetar sentencias de mongoDB ordenar - es el orden con el que se va a devolver la lista de registros limit - es la cantidad de registros que se va a devolver skip - es la cantidad de registros que se va a saltar antes de empezar a cargar los imtems de la lista que va a devolver concatenar - es utilizado para concatenar una coleccion con otra argsLocalBD - es una lista de listas que contiene los argumentos para la consulta en LocalBD los valores esperados son : [nombreCampo, operadorLogigo, valor] ejemplo: ['idServer', '=', '631f8b62d34bdc52b333879b'] Ejemplo para generar un nuevo Ciudadano:
obtieneEsquema({required String valor, String? clave = "data.coleccion", ModeToWork? modeToWork, String versionColeccion = '1'}) → Future<Map<String, dynamic>>
Funcion utilizada para obtener esquema de una coleccion como parametro requiere el nombre de la coleccion y opcionalmente la version de la coleccion si no se envia la version se toma por defecto la version 1 Propiedades: valor - es el nombre de la coleccion, idServer o cualquier otro valor por el cual se va a buscar. por defecto se busca por el campo data.coleccion que es el nombre de la coleccion. clave - es el campo por el cual se va a buscar el valor por defecto es data.coleccion si se quiere buscar por otro campo se debe pasar el nombre del campo.Ejemplo _id. modeToWork - es el modo de trabajo que se va a utilizar por defecto es ModeToWork.online versionColeccion - es la version de la coleccion que se va a buscar por defecto es 1
toString() → String
A string representation of this object.
inherited
uploadInfoToServer<T extends ColeccionBase>({required String coleccion, required String versionData, String? ordenar, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo}) → Future<Map<String, dynamic>>

Operators

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

Static Methods

logDebug(String message) → void