Fieldeas WEB API

Soporte Navegadores

Desarrollo

Api Docs

Modules

funciones

• funciones
  • checkVCA(timeout) ⏏
  • getter(value, data, timeout) ⏏
  • dispatch(value, data, timeout) ⏏
  • goHome(timeout) ⏏
  • changeApp(value, data, timeout) ⏏
  • storeInCache(value, data, timeout) ⏏
  • getFromCache(value, timeout) ⏏
  • getCache(timeout) ⏏
  • storeInFSCache(value, data, timeout) ⏏
  • getFromFSCache(value, timeout) ⏏
  • getFSCache(timeout) ⏏
  • isFSCacheLoaded(timeout) ⏏
  • getTheme(timeout) ⏏
  • getAssets(timeout) ⏏
  • setSpinner(value, data, timeout) ⏏
  • setSnackbar(value, data, timeout) ⏏
  • msgToDialog1() ⏏
  • msgToVFS() ⏏
  • openLogin() ⏏
  • closeLogin() ⏏
  • textLogin() ⏏
  • checkSession() ⏏
  • confirm(data) ⏏
  • ~~sendMessage(key, value, data, timeout) ⏏~~

checkVCA(timeout) ⏏

Comprueba si existe conexión con el VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

getter(value, data, timeout) ⏏

Para obtener algo de la store del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Valor de la store que queremos. | | data | * | Si el getter se obtiene en base a otro valor, se debe completar este campo. | | timeout | Number | Tiempo de espera de la solicitud. |

dispatch(value, data, timeout) ⏏

Para lanzar un dispatch a la sotre del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Valor del dispatch al que vamos a llamar. | | data | * | Si el dispatch tiene parámetros, se debe completar este campo. | | timeout | Number | Tiempo de espera de la solicitud. |

goHome(timeout) ⏏

Para ir al inicio

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

changeApp(value, data, timeout) ⏏

Para cambiar a otra aplicacion.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Alias de la aplicación a la que queremos ir. | | data | String | Ruta específica de la app a la que vamos (sin '/' inicial). | | timeout | Number | Tiempo de espera de la solicitud. |

storeInCache(value, data, timeout) ⏏

Para guardar algo en la cache del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Nombre del dato a guardar. | | data | * | Dato a guardar. | | timeout | Number | Tiempo de espera de la solicitud. |

getFromCache(value, timeout) ⏏

Para obtener algo de la cache del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Clave a obtener de la cache del VCA. | | timeout | Number | Tiempo de espera de la solicitud. |

getCache(timeout) ⏏

Para obtener toda la cache del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

storeInFSCache(value, data, timeout) ⏏

Para guardar algo en la cache de FS del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Nombre del dato a guardar. | | data | * | Dato a guardar. | | timeout | Number | Tiempo de espera de la solicitud. |

getFromFSCache(value, timeout) ⏏

Para obtener algo de la cache de FS del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Clave a obtener de la cache de FS del VCA. | | timeout | Number | Tiempo de espera de la solicitud. |

getFSCache(timeout) ⏏

Para obtener toda la cache de FS del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

isFSCacheLoaded(timeout) ⏏

Permite comprobar si se ha almacenado algún grupo de datos de FS

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

getTheme(timeout) ⏏

Para obtener el tema de Vuetify del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

getAssets(timeout) ⏏

Para obtener los assets del VCA.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | timeout | Number | Tiempo de espera de la solicitud. |

setSpinner(value, data, timeout) ⏏

Para activar o desactivar el spinner.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | Boolean | Activar o desactivar el spinner (si solo cambiamos el texto mandar null). | | data | String | Texto para el spinner. | | timeout | Number | Tiempo de espera de la solicitud. |

setSnackbar(value, data, timeout) ⏏

Para mostrar una snackbar.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | value | String | Texto del snackbar. | | data | Object | Objeto con las propiedades opcionales de la snackbar. | | data.color | String | Color hexadecimal o definido en las variables de vuetify. | | data.close | Boolean | Mostrar o no el botón para cerrar. | | data.timeout | Number | Tiempo para el cierre automático de la snackbar. | | timeout | Number | Tiempo de espera de la solicitud. |

msgToDialog1() ⏏

Para mandar un mensaje al primer dialogo de negocio.

Kind: Exported function

msgToVFS() ⏏

Para mandar un mensaje a VFS.

Kind: Exported function

openLogin() ⏏

Para abrir un cuadro de dialogo de login.

Kind: Exported function

closeLogin() ⏏

Para cerrar el cuadro de dialogo de login.

Kind: Exported function

textLogin() ⏏

Para mandar texto al cuadro de dialogo de login.

Kind: Exported function

checkSession() ⏏

Para chequear si la sesión está activa y renovarla en caso de que no lo esté.

Kind: Exported function

confirm(data) ⏏

Se muestra un mensaje de confirmación.

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | data | Object | Dato a guardar. se permite la introducción de los siguientes campos (todos opcionales) data: { title: "título", text: "mensaje", color: "primary", width: 290, zIndex: 200, okText: null, cancelText: null, cancelButton: true extraButtons: [], } |

~~sendMessage(key, value, data, timeout) ⏏~~

Deprecated

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | key | * | Clave del metodo a ejecutar. | | value | * | Valor del metodo. | | data | * | Datos adicionales. | | timeout | * | Tiempo de espera de la solicitud. |

callbacks

• callbacks
  • setOnThemeChange(fn) ⏏
  • setOnMsgFromDialog1(fn) ⏏
  • setOnMsgFromVFS(fn) ⏏

setOnThemeChange(fn) ⏏

Para establecer el callback cuando se cambiar el tema del VCA

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | fn | function | Función para ejecutar con un parametro de entrada |

setOnMsgFromDialog1(fn) ⏏

Para establecer el callback cuando se manda un mensaje desde el dialog1

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | fn | function | Función para ejecutar con un parametro de entrada |

setOnMsgFromVFS(fn) ⏏

Para establecer el callback cuando se manda un mensaje desde VFS

Kind: Exported function

| Param | Type | Description | | --- | --- | --- | | fn | function | Función para ejecutar con un parametro de entrada |

© 2019 Fieldeas.