Fieldeas WEB API

Soporte Navegadores

Desarrollo

Api Docs

Modules

Members

Application

• Application
  • .default
  • .getApplicationList() ⇒ Object

Application.default

fieldeas.application.js

Kind: static property of Application
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Application.getApplicationList() ⇒ Object

Devuelve la lista de aplicaciones del usuario

Kind: static method of Application

Data

• Data
  • .default
  • .errors : JSON
  • .downloadData(request, options, withBlobs) ⇒ Array.<Object>
  • .query(query) ⇒ Array.<Object>
  • .downloadQueryData(request) ⇒ Array.<Object>
  • .createTable(request)
  • .dropTable(name)
  • .addTableColumns(request)
  • .changeTableName(request)
  • .setRowsToSend(entity, condition, deleted)
  • .discardChanges()
  • .insert(request)
  • .update(request)
  • .multiUpdate(request)
  • .delete(request)
  • .select(request) ⇒ Array.<Object>
  • .getUser(request) ⇒ Object
  • .getUserList(request) ⇒ Array.<Object>
  • .setVar(name, data)
  • .getVar(name) ⇒ Value
  • .getPendingDataCount() ⇒ Number

Data.default

fieldeas.data.js

Kind: static property of Data
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Data.errors : JSON

Kind: static constant of Data
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"INVALID_COORDINATE":100,"INVALID_AUTOPOSITION_VALUE":101,"SQL":102,"NULL_REQUEST":103,"NULL_ENTITY":104,"NULL_ROWS":105,"NULL_FIELDS":106,"CONNECTION_ERROR":107,"SERVER_ERROR":108,"USER_NOT_FOUND":109,"COUNT_REQUIRED":110,"ENTITY_NOT_FOUND":111,"MISSING_REQUIRED_FIELD":112,"EMPTY_REQUIRED_FIELD":113,"INVALID_FIELD_TYPE":114,"DUPLICATED_PK":115,"INVALID_FIELD_LENGTH":116,"PK_UPDATE_NOT_ALLOWED":117,"FUNCTION_NOT_ALLOWED":200}

Data.downloadData(request, options, withBlobs) ⇒ Array.<Object>

Realiza una petición de datos (al servidor) de una entidad con un filtro dado y paginación. Adicionalmente se recoge un parámetro de opciones de almacenamiento de los registros obtenidos.

Kind: static method of Data
Returns: Array.<Object> - Registros obtenidos en la consulta
See: https://docs.fieldeas.com/api-mobile/data/downloaddata

| Param | Type | Description | | --- | --- | --- | | request | Object | Objeto con los parametros de la consulta | | request.entity | String | Nombre de la entidad Required | | request.filter | Object | Filtro de la descarga | | request.order | Array.<Object> | Parametros de la ordenacion | | request.order.field | String | Nombre del campo por el que ordenar | | request.order.type | String | ASC (ascendente) o DESC (descendente) | | request.count | Number | Numero de registros por pagina | | request.page | Number | Numero de la pagina a consultar | | options | Object | Opciones adicionales | | withBlobs | Boolean | Indica si se ha de descargar los campos tipo Blob | | request.options.storeData | Booleam | Indica si se ha de guardar los registros descargados en la base de datos del dispositivo |

Data.query(query) ⇒ Array.<Object>

Ejecuta una sentencia de tipo SELECT de SQLite contra la base de datos del dispositivo.

Kind: static method of Data
Returns: Array.<Object> - Registros obtenidos en la consulta
See: https://docs.fieldeas.com/api-mobile/data/query

| Param | Type | Description | | --- | --- | --- | | query | String | Sentencia de tipo SELECT de SQLite Required |

Data.downloadQueryData(request) ⇒ Array.<Object>

Ejecuta una query contra el servidor. No guarda los datos en el dispositivo.

Kind: static method of Data
Returns: Array.<Object> - Registros obtenidos en la consulta
See: https://docs.fieldeas.com/api-web/data/getdataquery

| Param | Type | Description | | --- | --- | --- | | request | Object | Objecto request Required |

Data.createTable(request)

Crea una tabla en la base de datos del dispositivo.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta Required | | request.name | String | Nombre de la tabla Required | | request.columns | Array.<Object> | Columnas para añadir Required | | request.columns.name | String | Nombre de la columna Required | | request.columns.type | String | Tipo de dato Required | | request.columns.length | Integer | Longitud del dato | | request.columns.primaryKey | Boolean | Clave primaria Required | | request.columns.autoIncrement | Boolean | Autoincremental Required | | request.columns.required | Boolean | Requerido Required | | request.columns.unique | Boolean | Irrepetible Required |

Data.dropTable(name)

Borra una tabla en la base de datos del dispositivo.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | name | String | Nombre la tabla Required |

Data.addTableColumns(request)

Añade columnas a una tabla en la base de datos del dispositivo.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta Required | | request.name | String | Nombre de la tabla Required | | request.columns | Array.<Object> | Columnas para añadir Required | | request.columns.name | String | Nombre de la columna Required | | request.columns.type | String | Tipo de dato Required | | request.columns.length | Integer | Longitud del dato | | request.columns.primaryKey | Boolean | Clave primaria Required | | request.columns.autoIncrement | Boolean | Autoincremental Required | | request.columns.required | Boolean | Requerido Required | | request.columns.unique | Boolean | Irrepetible Required |

Data.changeTableName(request)

Cambia el nombre de una tabla en la base de datos del dispositivo.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta Required | | request.name | String | Nombre de la tabla Required | | request.newName | String | Nuevo nombre de la tabla Required |

Data.setRowsToSend(entity, condition, deleted)

Establece datos de una entidad en la base de datos del dispositivo para enviar al servidor.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | entity | String | Nombre de la entidad Required | | condition | Object | Condición para el envío Required | | deleted | Boolean | Fuerza el borrado del dato Required |

Data.discardChanges()

Lanza una llamada al plugin limpiar los datos en memoria de la entidad

Kind: static method of Data

Data.insert(request)

Inserta un array de registros

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.entity | String | Nombre de la consulta Required | | request.rows | Array.<Object> | Datos a insertar Required | | request.coords | Object | Coordenadas en el momento de la insercion | | request.coords.auto | Boolean | Obtencion automatica de las coordenadas | | request.coords.lat | Number | Latitud | | request.coords.lon | Number | Longitud | | request.send | Boolean | Marca los datos para enviar | | request.deleted | Boolean | Marca los datos para borrar despues del envio |

Data.update(request)

Actualiza registros de una entidad

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.entity | String | Nombre de la consulta Required | | request.fields | Array.<Object> | Datos a actualizar Required | | request.condition | String | Condicion para actualizar | | request.coords | Object | Coordenadas en el momento de la insercion | | request.coords.auto | Boolean | Obtencion automatica de las coordenadas | | request.coords.lat | Number | Latitud | | request.coords.lon | Number | Longitud | | request.send | Boolean | Marca los datos para enviar | | request.deleted | Boolean | Marca los datos para borrar despues del envio |

Data.multiUpdate(request)

Ejecuta una actualizacion multiple

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.updates | Array.<Object> | Array de objetos de tipo 'update' |

Data.delete(request)

Borra un array de registros

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.entity | String | Nombre de la entidad Required | | request.condition | String | Condicion WHERE para eliminar |

Data.select(request) ⇒ Array.<Object>

Inserta un array de registros

Kind: static method of Data
Returns: Array.<Object> - Registros obtenidos en la consulta

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.entity | String | Nombre de la entidad Required | | request.fields | Array.<String> | Campos de la entidad | | request.condition | String | Condicion WHERE | | request.limit | Array.<Number> | Rango de registros | | request.order | Array.<String> | Ordenacion | | request.group | Array.<String> | Agrupacion |

Data.getUser(request) ⇒ Object

Devuelve la información del usuario indicado

Kind: static method of Data
Returns: Object - Objeto con la información del usuario

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de consulta | | request.login | String | Login del usuario |

Data.getUserList(request) ⇒ Array.<Object>

Obtiene una lista de información de usuarios.

Kind: static method of Data
Returns: Array.<Object> - Objeto con la información de los usuarios

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de consulta | | request.download | Boolean | Indica si se ha de almacenar los usuarios | | request.condition | String | Condición para recuperar (sintaxis WHERE de SQLite) | | request.count | Number | Numero de registros por pagina | | request.page | Number | Numero de pagina a consultar |

Data.setVar(name, data)

Almacena datos en una variable en la memoria del dispositivo.

Kind: static method of Data

| Param | Type | Description | | --- | --- | --- | | name | String | Nombre de la variable Required | | data | Any | Dato a almacenar. String, Number, Boolean, Array, Object Required |

Data.getVar(name) ⇒ Value

Recupera datos almacenados en una variable en la memoria del dispositivo.

Kind: static method of Data
Returns: Value - Valor asociado a la variable

| Param | Type | Description | | --- | --- | --- | | name | String | Nombre de la variable Required |

Data.getPendingDataCount() ⇒ Number

Devuelve el numero de registros pendientes de enviar

Kind: static method of Data
Returns: Number - Numero de registros

Device

• Device
  • .errors : JSON
  • .resourceType : JSON
  • .getBarcodeFromScanner() ⇒ String
  • .getDocumentFromScanner(target, customCamera, notifyOnCancel, customScan, resolutionMaxSize, cameraVersion, scanType) ⇒ Object
  • .getDocumentFromScannerCompressed(target, maxSize, customCamera, notifyOnCancel, customScan, resolutionMaxSize, cameraVersion, scanType) ⇒ Object
  • .getSignatureFromPaint(target, mode, notifyOnCancel, strokeWidth) ⇒ Object
  • .openFile(request)
  • .getFile(request) ⇒ Object
  • .openResource(request)
  • .getResource(request) ⇒ Object
  • .launchApp(packageName)
  • .getNetworkInformation() ⇒ Integer
  • .getDeviceInfo() ⇒ Object
  • .writeLog(type, text)
  • .sendLogFiles(dates, indexes, from, to)
  • .getNfcInfo() ⇒ Object
  • .getSystemUtcDate() ⇒ Object
  • .getImageFromPaint(backgroundImage, backgroundImageBase64, notifyOnCancel) ⇒ Object
  • .getFileFromBase64(data, extension) ⇒ Object
  • .getBase64FromFile(path) ⇒ Object
  • .injectToken(request) ⇒ Object

Device.errors : JSON

Kind: static constant of Device
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"APPLICATION_NOT_FOUND":100,"ACTION_NOT_SUPPORTED":101,"RESOURCE_TYPE_NOT_SUPPORTED":102,"RESOURCE_NOT_FOUND":103,"FILE_NOT_FOUND":104,"FILE_SIZE_EXCEEDED":105,"SYSTEM_UTC_DATE_ERROR":106,"LOCATION_NOT_AVAILABLE":200,"INVALID_ACTION":201,"NFC_NOT_SUPPORTED":300}

Device.resourceType : JSON

Kind: static constant of Device
Default: {"CLIENT":1,"APP":2,"LAYOUT":3}

Device.getBarcodeFromScanner() ⇒ String

Obtiene la cadena del código de barras del scanner del móvil

Kind: static method of Device
Returns: String - Codigo capturado

Device.getDocumentFromScanner(target, customCamera, notifyOnCancel, customScan, resolutionMaxSize, cameraVersion, scanType) ⇒ Object

Obtiene un documento del camScan

Kind: static method of Device
Returns: Object - {path, target} Objeto de respuesta

| Param | Type | Description | | --- | --- | --- | | target | String | Elemento donde cargar la imagen | | customCamera | Boolean | Camara custom | | notifyOnCancel | Boolean | Notifica en el callbackOK si se ha cancelado la acción | | customScan | Boolean | Scanner custom | | resolutionMaxSize | Integer | Dimensiones máximas de la imagen | | cameraVersion | Integer | Versión de la cámara personalizada (1 o 2) | | scanType | String | Tipo de escáner ("" o "mlkit") |

Device.getDocumentFromScannerCompressed(target, maxSize, customCamera, notifyOnCancel, customScan, resolutionMaxSize, cameraVersion, scanType) ⇒ Object

Obtiene un documento del camScan comprimido al tamaño máximo que se le pasa por parámetro

Kind: static method of Device
Returns: Object - {path, target} Objeto de respuesta

| Param | Type | Description | | --- | --- | --- | | target | String | Elemento donde cargar la imagen | | maxSize | Integer | Tamaño máximo | | customCamera | Boolean | Camara custom | | notifyOnCancel | Boolean | Notifica en el callbackOK si se ha cancelado la acción | | customScan | Boolean | Scanner custom | | resolutionMaxSize | Integer | Dimensiones máximas de la imagen | | cameraVersion | Integer | Versión de la cámara personalizada (1 o 2) | | scanType | String | Tipo de escáner ("" o "mlkit") |

Device.getSignatureFromPaint(target, mode, notifyOnCancel, strokeWidth) ⇒ Object

Obtienes una firma desde nativo

Kind: static method of Device
Returns: Object - {path, target} Objeto de respuesta

| Param | Type | Description | | --- | --- | --- | | target | String | Elemento donde cargar la imagen | | mode | String | Modo imagen o firma | | notifyOnCancel | Boolean | Notifica en el callbackOK si se ha cancelado la acción | | strokeWidth | Boolean | strokeWidth |

Device.openFile(request)

Abre un archivo

Kind: static method of Device

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.path | String | Ruta del archivo Required |

Device.getFile(request) ⇒ Object

Abre una pantalla de selección de archivos, en el que se puede indicar la extension

Kind: static method of Device
Returns: Object - {path, size} Objeto de respuesta

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.extensions | Array.<String> | Array de extensiones - [".txt", ".pdf", ...] |

Device.openResource(request)

Abre un archivo subido como recurso al Manager Web, mediante una aplicación instalada en el dispositivo.

Kind: static method of Device

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.type | Number | Tipo de recurso [resourceType] Required | | request.name | String | Nombre del archivos Required |

Device.getResource(request) ⇒ Object

Devuelve la ruta de un archivo subido como recurso al Manager Web.

Kind: static method of Device
Returns: Object - {path, size} Objeto de respuesta

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.type | Number | Tipo de recurso [resourceType] Required | | request.name | String | Nombre del archivos Required |

Device.launchApp(packageName)

Lanza una aplicación instalada en el dispositivo

Kind: static method of Device

| Param | Type | Description | | --- | --- | --- | | packageName | String | Nombre del paquete de la aplicación Required |

Device.getNetworkInformation() ⇒ Integer

Obtiene el tipo de conexión al que esta conectado el dispositivo

Kind: static method of Device
Returns: Integer - Tipo de conexión [Connection]

Device.getDeviceInfo() ⇒ Object

Obtiene la información del dispositivo

Kind: static method of Device
Returns: Object - {appMemoryUse, battery, {year, month, day, hour, minute, second}, freeStorage, id, memoryFree, memoryInUse, model, name, systemName, systemVersion, totalMemory, totalStorage}

Device.writeLog(type, text)

Escribe en el log persistente del dispositivo

Kind: static method of Device

| Param | Type | Description | | --- | --- | --- | | type | char | Caracter que define el tipo de mensaje | | text | string | Texto que se insertará |

Device.sendLogFiles(dates, indexes, from, to)

Envía archivos de log al servidor, se debe enviar o "dates" o "indexes" o "from" + "to"

Kind: static method of Device

| Param | Type | Description | | --- | --- | --- | | dates | Object | Array de fechas a enviar, aceptando formatos "DD", "DD/MM", "DD/MM/YYYY" | | indexes | Object | Array de index de los que se enviarán los logs | | from | Object | index desde el que se envían los logs | | to | Object | index hasta el que se envían los logs |

Device.getNfcInfo() ⇒ Object

Devuelve la información NFC

Kind: static method of Device
Returns: Object - {supported, enabled}

Device.getSystemUtcDate() ⇒ Object

Devuelve la fecha del servidor

Kind: static method of Device
Returns: Object - {date, timestamp}

Device.getImageFromPaint(backgroundImage, backgroundImageBase64, notifyOnCancel) ⇒ Object

Permite dibujar sobre una imagen

Kind: static method of Device
Returns: Object - {path, size}

| Param | Type | Description | | --- | --- | --- | | backgroundImage | string | Path de la imagen sobre la que se quiere pintar | | backgroundImageBase64 | string | Base64 de la imagen sobre la que se quiere pintar | | notifyOnCancel | Boolean | Notifica en el callbackOK si se ha cancelado la acción |

Device.getFileFromBase64(data, extension) ⇒ Object

Convierte un base64 en una archivo y devulve la ruta a este

Kind: static method of Device
Returns: Object - {path, size}

| Param | Type | Description | | --- | --- | --- | | data | String | Base64 | | extension | String | Extension del archivo. Opcional. |

Device.getBase64FromFile(path) ⇒ Object

Convierte un archivo en base64

Kind: static method of Device
Returns: Object - {data}

| Param | Type | Description | | --- | --- | --- | | path | String | Ruta del archivo |

Device.injectToken(request) ⇒ Object

Configura el uso de un token de Fieldeas en los encabezados de las solicitudes a APIs.

Kind: static method of Device
Returns: Object - {data} false: el método no está disponible en la versión de la aplicación que se está ejecutando

| Param | Type | Description | | --- | --- | --- | | request | Object | Opcional. Parámetros de configuración para habilitar el uso del token. Si no se especifica, el token se habilitará para las APIs de productos de Fieldeas. | | request.tokenHeader | String | Nombre del campo del encabezado donde se insertará el token. | | request.matchUrls | Object | Lista de URLs (o patrones) que se comprobarán al realizar una solicitud. Si una URL coincide con algún patrón, el token se incluirá en el encabezado. |

Errors

FieldServices

• FieldServices
  • .default
  • .errors : JSON
  • .getTemplateList(request)
  • .getTaskList(request)
  • .getElementList(request)
  • .getAttachmentList(request)
  • .getAttachment(request)
  • .createJob(request)

FieldServices.default

fieldeas.fieldservices.js

Kind: static property of FieldServices
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

FieldServices.errors : JSON

Kind: static constant of FieldServices
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"CONNECTION_ERROR":100,"SERVER_ERROR":101}

FieldServices.getTemplateList(request)

Petición de plantillas

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

FieldServices.getTaskList(request)

Petición de tareas en base a unos parámetros

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

FieldServices.getElementList(request)

Petición de elementos en base a unos parámetros

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

FieldServices.getAttachmentList(request)

Petición de adjuntos (sin binario)

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

FieldServices.getAttachment(request)

Petición de un adjunto (con binario)

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

FieldServices.createJob(request)

Crea un trabajo en el servidor

Kind: static method of FieldServices

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta |

Fleet

• Fleet
  • .default
  • .errors : JSON
  • .startWatchingNearbyPoints()
  • .stopWatchingNearbyPoints()
  • .getVehicles(request)
  • .getStates(request)
  • .getAlarms(request)
  • .setVehicle(request)
  • .setState(uid)
  • .fireAlarm(request)
  • .getCurrentVehicle() ⇒ Object
  • .getCurrentState() ⇒ Object
  • .startTrackingThread()
  • .stopTrackingThread()
  • .changeTrackingConfig(request)

Fleet.default

fieldeas.fleet.js

Kind: static property of Fleet
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Fleet.errors : JSON

Kind: static constant of Fleet
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"INVALID_FORMAT_TYPE":3,"NO_TRACKING":100,"VEHICLE_NOT_FOUND":101,"STATE_NOT_FOUND":102,"ALARM_NOT_FOUND":103,"VEHICLE_NOT_ESTABLISHED":104,"LOCATION_NOT_AVAILABLE":105,"COORDINATES_NOT_AVAILABLE":105,"FREQUENCY_ERROR":107,"MODE_ERROR":108,"TRACKING_ERROR":109,"INVALID_ACTION":201,"CONNECTION_ERROR":206,"NOT_NAVIGATED_POINT":207}

Fleet.startWatchingNearbyPoints()

Petición de comienzo de búsqueda de puntos cercanos

Kind: static method of Fleet

Fleet.stopWatchingNearbyPoints()

Petición de finalización de búsqueda de puntos cercanos

Kind: static method of Fleet

Fleet.getVehicles(request)

Obtiene los vehiculos

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.download | boolean | Establece si tiene que realizar la descarga |

Fleet.getStates(request)

Obtiene los estados

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.download | boolean | Establece si tiene que realizar la descarga |

Fleet.getAlarms(request)

Obtiene las Alarmas

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.download | boolean | Establece si tiene que realizar la descarga |

Fleet.setVehicle(request)

Vincula un vehículo

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.uid | long | Id del vehículo Required |

Fleet.setState(uid)

Registra el estado

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | uid | Integer | Id del estado Required |

Fleet.fireAlarm(request)

Dispara una alarma

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.alarmId | Integer | Id de la alarma | | request.message | String | Mensaje de la alarma | | request.autoposition | Boolean | Registra la posición actual | | request.attempts | Integer | Intentos de registrar | | request.lat | Long | Latitud | | request.lon | Long | Longitud |

Fleet.getCurrentVehicle() ⇒ Object

Obtiene el vehiculo actual vinculado

Kind: static method of Fleet
Returns: Object - Vehiculo actual

Fleet.getCurrentState() ⇒ Object

Obtiene el estado actual

Kind: static method of Fleet
Returns: Object - Estado actual

Fleet.startTrackingThread()

Inicia el hilo de tracking

Kind: static method of Fleet

Fleet.stopTrackingThread()

Detiene el hilo de tracking

Kind: static method of Fleet

Fleet.changeTrackingConfig(request)

Cambia la configuración de flotas

Kind: static method of Fleet

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.traceFrequency | int | Tiempo de guardado de coordenada en segundos. Required | | request.sentFrequency | int | Tiempo de envío de coordenadas en segundos. Required | | request.mode | int | 0 = Disabled, 1 = Offline, 2 = Online Required |

Geofence

• Geofence
  • .default
  • .errors : JSON

Geofence.default

fieldeas.geofence.js

Kind: static property of Geofence
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2021

Geofence.errors : JSON

Kind: static constant of Geofence
Default: {"LOCATION_PERMISSION_DENIED":100}

Helpers

• Helpers
  • .errors : JSON
  • .platform : JSON
  • .getThumbnailImage(path) ⇒ String
  • .getOriginalImage(path) ⇒ String
  • .getPlatform() ⇒ Number

Helpers.errors : JSON

Kind: static constant of Helpers
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2}

Helpers.platform : JSON

Kind: static constant of Helpers
Default: {"IOS":1,"ANDROID":2,"WINDOWS_PHONE":4,"WINDOWS_DESKTOP":7,"WINDOWS_8":8}

Helpers.getThumbnailImage(path) ⇒ String

Devuelve la ruta al thumbnail de una imagen

Kind: static method of Helpers
Returns: String - Ruta a la imagen thumbnail

| Param | Type | Description | | --- | --- | --- | | path | String | Ruta a la imagen original |

Helpers.getOriginalImage(path) ⇒ String

Devuelve la ruta original de un thumbnail

Kind: static method of Helpers
Returns: String - Ruta a la imagen original

| Param | Type | Description | | --- | --- | --- | | path | String | Ruta a la imagen thumbnail |

Helpers.getPlatform() ⇒ Number

Devuelve en número de plataforma en la que se está ejecutando la aplicación

Kind: static method of Helpers
Returns: Number - Número asociado a Platform

Language

Language.default

fieldeas.language.js

Kind: static property of Language
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Location

• Location
  • .errors : JSON
  • .getLocationFromMaps(target) ⇒ String
  • .getCoords(maxAttempts)
  • .getRouteTo(request) ⇒ Integer
  • .getTimeToArrive()
  • .getAddressByCoords(request) ⇒ Object
  • .getCoordsByAddress(request) ⇒ Object
  • .isLocationEnabled()
  • .openLocationSettings()

Location.errors : JSON

Kind: static constant of Location
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"LOCATION_NOT_AVAILABLE":105,"INVALID_COORDINATE":106,"INVALID_ADDRESS":107,"INVALID_ACTION":201,"CONNECTION_ERROR":206}

Location.getLocationFromMaps(target) ⇒ String

Obtiene la localización actual en un mapa del móvil

Kind: static method of Location
Returns: String - Direccion seleccionada

| Param | Type | Description | | --- | --- | --- | | target | String | Identificador del elemento html |

Location.getCoords(maxAttempts)

Petición de coordenadas GPS

Kind: static method of Location

| Param | Type | Description | | --- | --- | --- | | maxAttempts | Integer | Número máximo de intentos |

Location.getRouteTo(request) ⇒ Integer

Establece la llamada al componente de navegación (google maps) asociados al componente

Kind: static method of Location
Returns: Integer - Error Cod de Error si no es una coordenada navegable

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.latitude | Integer | Latitud Required | | request.longitude | Integer | Longitud Required | | request.text | String | Descripcion |

Location.getTimeToArrive()

Método no disponible ya que requiere de la carga de la libería de google maps

Kind: static method of Location

Location.getAddressByCoords(request) ⇒ Object

Devuelve una dirección dada unas coordenadas

Kind: static method of Location
Returns: Object - address {latitude, longitude, address}

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.latitude | Object | Latitud Required | | request.longitude | Object | Longitud Required |

Location.getCoordsByAddress(request) ⇒ Object

Devuelve unas coordendas dada una dirección

Kind: static method of Location
Returns: Object - coords {latitude, longitude, address}

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.address | Object | Direccion |

Location.isLocationEnabled()

Indica si la localización está habilitada

Kind: static method of Location

Location.openLocationSettings()

Abre la configuracion nativa de Location

Kind: static method of Location

Messaging

• Messaging
  • .default
  • .errors : JSON
  • .sendMessage(request)
  • .showMessagingDialog()
  • .getPendingMessagesCount(object)
  • .downloadMessages(request)
  • .downloadMessageBody(request)
  • .dispatchPushCommands()

Messaging.default

fieldeas.messaging.js

Kind: static property of Messaging
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Messaging.errors : JSON

Kind: static constant of Messaging
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"MISSING_USER":100,"MISSING_SUBJECT":101,"MISSING_BODY":102,"USER_NOT_FOUND":103,"UNABLE_TO_SEND":104,"SENT_BOX_STORED":105}

Messaging.sendMessage(request)

Envía un mensaje a un usuario

Kind: static method of Messaging

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.to | Array.<String> | Destinatarios Required | | request.subject | String | Asunto | | request.body | String | Cuerpo del mensaje |

Messaging.showMessagingDialog()

Muestra la pantalla de mensajería nativa

Kind: static method of Messaging

Messaging.getPendingMessagesCount(object)

Mensajes pendientes de leer

Kind: static method of Messaging

| Param | Type | Description | | --- | --- | --- | | object | Object | {count: integer} |

Messaging.downloadMessages(request)

Descarga mensajes

Kind: static method of Messaging

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.dateTime | String | Fecha a partir de la cual se quieren pedir los mensajes en formato dd/MM/yyyy HH:mm:ss | | request.page | Number | Número de la página | | request.count | Number | Número de registros por página | | request.isAsc | Boolean | Ordenación por fecha (true ascendente, false descendente) |

Messaging.downloadMessageBody(request)

Descarga el body de un mensaje

Kind: static method of Messaging

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.messageId | String | ID del mensaje a descargar el contenido |

Messaging.dispatchPushCommands()

Pide que se despachen los mensajes push que hayan llegado mientras la aplicación no se encuentra en primer plano

Kind: static method of Messaging

Navigate

• Navigate
  • .default
  • .errors : JSON
  • .goToScreen(path)
  • .goToLogin()
  • .goToBack()
  • .goToAppList()
  • .goToApp(request)
  • .exit()

Navigate.default

fieldeas.navigate.js

Kind: static property of Navigate
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Navigate.errors : JSON

Kind: static constant of Navigate
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2}

Navigate.goToScreen(path)

Carga una pantalla

Kind: static method of Navigate

| Param | Type | Description | | --- | --- | --- | | path | String | Url de de destino del html de la pantalla a ir |

Navigate.goToLogin()

Muestra la pantalla de login

Kind: static method of Navigate

Navigate.goToBack()

Vuelve a la ultima pantalla visitada

Kind: static method of Navigate

Navigate.goToAppList()

Hace un check de los datos de acceso y si es Ok Envía a la AppListScreen

Kind: static method of Navigate

Navigate.goToApp(request)

Abre una aplicacion mediante un alias

Kind: static method of Navigate

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.alias | String | Nombre que se debe indicar en el Layout | | request.screen | String | (opcional) Nombre de la pantalla que se quiere abrir |

Navigate.exit()

Sale de la aplicación FIELDEAS - "Solo Aplica a plataformas Android"

Kind: static method of Navigate

Ocr

• Ocr
  • .default
  • .errors : JSON

Ocr.default

fieldeas.ocr.js

Kind: static property of Ocr
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2021

Ocr.errors : JSON

Kind: static constant of Ocr
Default: {"CAMERA_PERMISSION_DENIED":100,"FILE_NOT_FOUND":101}

Pdf

• Pdf
  • .default
  • .errors : JSON
  • .mergePDF(folder, paths)
  • .fillPDF(folder, path, fields)

Pdf.default

fieldeas.pdf.js

Kind: static property of Pdf
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Pdf.errors : JSON

Kind: static constant of Pdf
Default: {"BAD_REQUEST":3,"FILE_NOT_FOUND":4}

Pdf.mergePDF(folder, paths)

Combina dos o mas PDF en uno solo

Kind: static method of Pdf

| Param | Type | Description | | --- | --- | --- | | folder | String | Carpeta donde se encuenta el fichero. CLIENTDIR | APPDIR | "" | | paths | Array.<String> | Rutal del fichero |

Pdf.fillPDF(folder, path, fields)

Rellena un PDF

Kind: static method of Pdf

| Param | Type | Description | | --- | --- | --- | | folder | String | Carpeta donde se encuenta el fichero. CLIENTDIR | APPDIR | "" | | path | String | Rutal del fichero | | fields | Object | Campos de la plantilla a rellenar |

Signply

• Signply
  • .default
  • .errors : JSON
  • .sign(path)

Signply.default

fieldeas.signply.js

Kind: static property of Signply
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Signply.errors : JSON

Kind: static constant of Signply
Default: {}

Signply.sign(path)

Firma un PDF

Kind: static method of Signply

| Param | Type | Description | | --- | --- | --- | | path | String | Ruta del PDF |

Sync

• Sync
  • .default
  • .errors : JSON
  • .syncEntityData(entity)
  • .downloadApps()

Sync.default

fieldeas.sync.js

Kind: static property of Sync
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Sync.errors : JSON

Kind: static constant of Sync
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"MISSING_ENTITIES":100,"ENTITY_NOT_FOUND":101,"CONNECTION_ERROR":102,"SERVER_ERROR":103}

Sync.syncEntityData(entity)

Le dice al core que sincronice con fieldeas los datos que tiene pendientes de enviar

Kind: static method of Sync

| Param | Type | Description | | --- | --- | --- | | entity | Array.<String> | Nombre de la entidad |

Sync.downloadApps()

Sincroniza las aplicaciones, datos y recursos

Kind: static method of Sync

Ux

• Ux
  • .default
  • .errors : JSON
  • .showAlert(request)
  • .showConfirm(request)
  • .showMessagingDialog()
  • .showLoginConfigDialog()
  • .showApplistConfigDialog()
  • .showPendingDataMessage()
  • .showSpinner(request)
  • .hideSpinner()
  • .openDatePicker(request)
  • .openTimePicker(request)
  • .openDateTimePicker(request)
  • .setOrientation(request)

Ux.default

fieldeas.ux.js

Kind: static property of Ux
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Ux.errors : JSON

Kind: static constant of Ux
Default: {"GENERIC_ERROR":1,"MISSING_PARAMETERS":2,"INVALID_ORIENTATION":100}

Ux.showAlert(request)

Muestra un mensaje

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.message | String | Mensaje | | request.title | String | Titulo | | request.buttonLabel | String | Titulo del boton |

Ux.showConfirm(request)

Muestra un mensaje de Confirmación

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.message | String | Mensaje | | request.title | String | Titulo | | request.buttonLabel | String | Titulo del boton |

Ux.showMessagingDialog()

Muestra la pantalla de mensajería nativa

Kind: static method of Ux

Ux.showLoginConfigDialog()

Lanza una llamada al plugin para abrir la ventana de configuracion nativa

Kind: static method of Ux

Ux.showApplistConfigDialog()

Lanza una llamada al plugin para abrir la ventana de configuracion nativa

Kind: static method of Ux

Ux.showPendingDataMessage()

Lanza una llamada al plugin para devolver los elementos pendientes de enviar

Kind: static method of Ux

Ux.showSpinner(request)

Muestra la mascara de carga con mensaje

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.title | String | Titulo | | request.message | String | Mensaje |

Ux.hideSpinner()

Le dice al core que oculte una mascara de cargando

Kind: static method of Ux

Ux.openDatePicker(request)

Muestra un datePicker Nativo

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.year | Integer | Año | | request.month | Integer | Mes | | request.day | Integer | Dia |

Ux.openTimePicker(request)

Muestra un timePicker Nativo

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.hour | Integer | Hora | | request.minute | Integer | Minuto | | request.second | Integer | Segundo |

Ux.openDateTimePicker(request)

Muestra un archivo dateTimePicker Nativo

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.year | Integer | Año | | request.month | Integer | Mes | | request.day | Integer | Dia | | request.hour | Integer | Hora | | request.minute | Integer | Minuto | | request.second | Integer | Segundo |

Ux.setOrientation(request)

Cambia la orientación de la pantalla actual

Kind: static method of Ux

| Param | Type | Description | | --- | --- | --- | | request | Object | Parametros de la consulta | | request.orientation | String | Tipo de orientacion |

_fieldeas

fieldeas.helpers.js

Kind: global variable
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

fieldeas

fieldeas.js

Kind: global variable
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

_fieldeas

fieldeas.location.js

Kind: global variable
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

Media

fieldeas.media.js

Kind: global variable
See: API Documentation for developers
Copyright: Fieldeas S.L. 2014-2018

• Media
  • .errors : JSON
  • .androidAudioFormat : JSON
  • .androidAudioEncoder : JSON
  • .iOSAudioFormat : JSON
  • .wp8AudioFormat : JSON
  • .iOSVideoQuality : JSON
  • .getAudioFromRecorder() ⇒ Object
  • .startRecordingAudio()
  • .startPlayingAudio(request)
  • .stopRecordingAudio() ⇒ Object
  • .stopPlayingAudio()
  • .getAudioFromGallery() ⇒ Object
  • .getImageFromCamera(request) ⇒ Object
  • .getImageFromGallery(request, notifyOnCancel, isMultiSelection, maxItems, resolutionMaxSize) ⇒ Object
  • .openImage(request)
  • .getVideoFromCamera(request) ⇒ Object
  • .getVideoFromGallery() ⇒ Object
  • .openVideo(request)
  • .openAudio(request)

Media.errors : JSON

Kind: static constant of Media
Default: {"MICROPHONE_NOT_FOUND":100,"FILE_NOT_FOUND":101,"NOT_RECORDING":102,"NOT_PLAYING":103,"FORMAT_NOT_SUPPORTED":104,"ENCODER_NOT_SUPPORTED":105,"INVALID_ACTION":201}

Media.androidAudioFormat : JSON

Formatos de audio disponibles para Android

Kind: static constant of Media
Default: {"THREE_GPP":1,"MPEG_4":2,"AMR_NB":3,"AMR_WB":4,"AAC_ADTS":6}

Media.androidAudioEncoder : JSON

Codificadores de audio disponibles para Android

Kind: stati