Clase CloudFrameWorkCFA
Clase para dar soporte a las aplicaciones de CFA y es incluida por la aplicación principal CFI (CloudFramework Interface) /app.html
<script src="/ajax/js/cfa.js?v20231130_1"></script>
Esta clase permite la interacción avanzada con el usuario representando el resultado de llamadas APIs que devuelven una estructura JSON que puede ser representada visualmente y con interacciones avanzadas de usuario.
[ COPY webapp-module-..] /erp/js/classes/CloudFrameWorkCFA.apiToInterface | 0.DEFINED [0.DEFINED]/**
* Execute an action to launch a CFO for edit
* @param url with format: '/cfi/{CFOId}/{display,update}/{id}'
*/
this.CFO = function(url,callback) {
..
}
/**
* Call to urlBase+'/'+CloudFrameWorkCFA.platform+'/'+encodeURIComponent(user)+'/cfa'+apiUrl
* expecting that end-point it is ready to return a CFA structure
* @param apiUrl the substring uses as API url to be used as follows: urlBase+'/'+CloudFrameWorkCFA.platform+'/'+encodeURIComponent(user)+'/cfa'+apiUrl
* @param user [optional] allows to rewrite default value CloudFrameWorkCFA.userId
* @param updatePageParam [optional] if true then rewrite the Browser url the value of the parameter ?p= with the apiUrl
* @param urlBase [optional] allows to rewrite the default urlBase = CloudFrameWorkCFA.urlBase
*/
this.apiToInterface = function (apiUrl,user,updatePageParam,urlBase) {
..
}
/**
*
* @param {*} payload = Method configuration object
* @param String payload.api = Api url for obtaining CFA component data
* @param String payload.size = Configure modal size. Sizes: 'sm': small, null: default lg size , 'lg': large, 'xl': extra large, 'xxl': 90vw
* @param String payload.type = Modal type, right modal or center modal. right modal by default
*/
this.modal = async (payload) =>{
..
}
Este método facilita la carga de una aplicación CFA dentro de una modal, además de permitir ciertos parámetros de personalización a través del objeto de configuración "payload"
Variables:
payload (Object) | Objeto de configuración de la modal. Dicho objeto acepta los siguiente parámetros |
payload.api: (String) | Ruta donde está el END-POINT con la aplicación cfa hacia donde se realizará una llamada [GET] |
payload.size: (String) | Tamaño de la modal. Este parámetro acepta los siguientes valores
|
payload.type: (String) | Tipo de modal. Existen 2 tipos, modal derecha o modal central |
payload.onclose: (Function) | Función que actuará como callback y se disparará cuando la modal se cierre |
Muestra en una modal de contenido información de CLOUD-DOCUMENTUM.
/**
* Show a modal with CLOUD-DOCUMENTUM content calling the API https//api.cloudframework.io/erp/dev-docs
* #params string route It will be 'route' to be shown as a CLOUD-DOCUMENT
*/
// Show a HTML info from the lateral selfPageModal
this.showDevDocPage = function(route) {
..
}
Podrás llamar a este método desde una consola, un enlace o una WebApp utilizando el objeto global [CloudFrameWorkCFA]
CloudFrameWorkCFA.showDevDocPage('<route>');
Ve a la definición del API /erp/dev-docs para más información.