ApiRest class

Available extensions

Constructors

ApiRest({required CloudDb cloudDb, required MobileDb mobileDb, 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
mobileDb → MobileDb
final
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
autorizaSesion({required String clientId, required String clientSecret}) → Future<Map<String, dynamic>>
Este evento es utilizado para autorizar la sesion del usuario este evento se ejecuta cuando se realiza un login o cuando el status de la peticion al servidor devuelve un sataus == 400 y inStatus == 101 parametros
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 de tipo QueryPropertiesWrapper que contiene las propiedades que se van a utilizar para la consulta runIsolate - es un valor booleano que indica si se va a ejecutar en un isolate tipoId - es el tipo de id que se va a utilizar para la consulta si es idMobile o idServer
downLoadInfoFromServer<T extends ColeccionBase>({required String coleccion, String? consulta, QueryPropertiesWrapper<T>? queryPropertiesWrapper, T? modelo}) → Future<Map<String, dynamic>>
Funcion utilizada para obtener un lista de registros de una coleccion determinada en modo offline es decir sincroniza los datos del servidor con los datos del dispositivo consulta - es la consulta que se va a ejecutar en el servidor esta es opcional si no se envia nada en este parametro se obtiene el ultimo creadoEl del dispositivo y se establece como consulta lo siguiente
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>
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 LocalDB 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
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>>
Funcion utilizada para subir la informacion del dispositivo al servidor lee los registros con el campo eTransfer igual a D y los envia al servidor parametros solicitados requeridos parametros solicitados requeridos coleccion - es la coleccion que se quiere leer y obtener los registros ordenar - es el orden con el que se va a devolver la lista de registros ejemplo jsonEncode({'data.idCiudadano': 1}) queryPropertiesWrapper - es un objeto de tipo QueryPropertiesWrapper que contiene las propiedades que se van a utilizar para la consulta si no se envia nada se toma por defecto el objeto ColeccionObjBoxWrapper() modelo - es el modelo que se va a utilizar para la consulta si no se envia nada se toma por defecto el objeto ColeccionObjBox()

Operators

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

Static Methods

logDebug(String message) → void