CloudFrameWorkInterface()

Este método prepara el entorno inicializando las configuraciones y parámetros necesarios para que CloudFrameWorkInterface funcione correctamente, gestionando la autenticación y las configuraciones de API según las necesidades del entorno y del usuario. Además inicializa varias variables de la clase Core, necesarias para el funcionamiento de la plataforma

Variables: 

​

CloudFrameWorkInterface.init(()=>{ console.log('Framework iniciado')})

Este método facilita la creación y manejo de modales en la parte derecha de la aplicación. Dichas modales pueden mostrar contenido html proporcionado o bien pueden ser utilizadas para cargar una aplicación creada para tal propósito, además de permitir ciertos parámetros de personalización a través del objeto de configuración "payload"

[2024-09-13]

Se añade la posibilidad de tener múltiples modales abiertas al mismo tiempo en la plataforma.

Variables: 

CloudFrameWorkInterface.rightModal(payload); 
{
    title:'Modal title', // Modal title
    icon:'fa-user', // Modal icon
    size:'xl', // Modal sizes: 'sm': small, null: default md size , 'lg': large, 'xl': extra large, 'xxl': 90vw
    content: 'Modal html content' // html content for the modal    
}

​Este método ejecutará una función cuando el estado de ‘CloudFrameWorkInterface.initiated’ cambie a verdadero. El proceso es recursivo y la función toma un parámetro ‘callback’, que será la función por ejecutar. La comprobación del estado se realiza cada 250 ms. ​

Variables:

CloudFrameWorkInterface.waitUntilInit(()=>{ console.log('Proceso ejecutado')})

El método verifica si el usuario está autenticado.

Si lo está, importa las variables ‘apiURL’, ‘cloudplatform’ y ‘webKey’ definidas en la configuración del usuario desde ‘Core’ a ‘CloudframeworInterface’. Luego, comprueba la validez del token.

Si el usuario no está autenticado o el token es inválido, se elimina la información del usuario de las cookies y se resetean los datos.

​Variables:

CloudFrameWorkInterface.checkAuth(()=>{ console.log('verificación completada')})
//Output 'verificación completada'

Este método permite iniciar sesión mediante correo electrónico y contraseña. Si el inicio de sesión es exitoso, se almacenará el token en las cookies y se guardará la información recibida en el Core.

Variables:

CloudFrameWorkInterface.signInWithUserPassword('user@mail.com','pass12345',()=>{ console.log('Sesión iniciada')})

Este método permite iniciar sesión mediante un token.

​El proceso validara el estado del token. Si la comprobación resulta exitosa se almacenará el token en las cookies y se guardará la información del EP recibida, en el Core.​

Variables:

CloudFrameWorkInterface.signInWithDSToken('token_12345', ()=>{ console.log('Sesión iniciada')})

Esta función está en desuso.

Esta función está en desuso.

Esta función está en desuso.

Esta función está en desuso.

Este método permite cerrar la sesión del usuario.

Al finalizar el proceso, se limpiara la cache y redireccionara al usuario a la pantalla de inicio de sesión.

Variables:

CloudFrameWorkInterface.logOut(()=>{ console.log('Usuario desconectado')})

Este método activará la librería JSON Editor en aquellos campos que sean de tipo ‘JSON’ y esten dentro de un contenedor con la clases 'show.bs.modal'.

Su uso se puede ver implementado en los CFO para dar formato a elementos de la base de datos de tipo (JSON | Objeto).

Ejemplo:​

CloudFrameWorkInterface.initJsonEditors()

Este método inicializa todos los elementos presentes en el DOM con la clase ‘json-editor’, permitiendo gestionar de forma más sencilla los objetos de tipo JSON. Además, brinda la posibilidad de cambiar la vista entre el modo Árbol o Código.

​Ejemplo:

Vista en Modo Arbol:

Vista en Modo Código:

CloudFrameWorkInterface.formatJSONFields()

La ejecución de este método validará, si la plataforma actual, cuenta con el servicio de omnicanal activo.

Además, esta validación activará en el 'header' el botón para comunicarse a través de ‘WhatsApp’ en caso de que el servicio esté activo y visible en la configuración.

​Ejemplo:

CloudFrameWorkInterface.checkMarketplaceApps()

El método validará si el usuario conectado ha aceptado la versión más reciente de los términos y condiciones.

En caso de no haberlos aceptado, se mostrará una ventana modal, indicándole información con los nuevos términos y la opción de aceptarlos. De no aceptarlos, se bloqueará el acceso a la plataforma.

Ejemplo:

CloudFrameWorkInterface.  checkLegal()

Esta función capitaliza la primera letra de cada parte de un string, separado por un delimitador y las combina. 

Variables:

CloudFrameWorkInterface.generateCapitals('Cloud=Framework','=');
//Output: 'CF'

Este método actualiza el menú de navegación con el valor proporcionado en el parámetro ‘customMenu’. Si no se proporciona dicho valor, se recargará el menú con la configuración por defecto.

​OJO! Al recargar la página, el menú volverá a su valor por defecto.

Variables:

CloudFrameWorkInterface.refreshMainMenu({
    "editable": false,
    "Organizations": [
        {
            "Organization": "cfw",
            "OrganizationIndex": 1,
            "OrganizationName": "Menu name",
            "OrganizationLogo": "image",
            "OrganizationHomeTemplate": "www.cloudfw.io",
            "OrganizationHomeIcon": "fa-home",
            "OrganizationFavicon": "",
            "OrganizationMenu": [                {
		 icon: "fa-calendar",
		 level: 0,
		 name: "Sub menu option",
		 security: null,
		 template: "www.cloudfw.io/test"
		}							
	    ],
            "OrganizationHomeHidden": false
        }
    ]
});
// Los iconos disponibles son de Font Awesome

Este método inicia la carga de scripts, estilos y complementos necesarios para el funcionamiento del sistema. El proceso se ejecutará al iniciar sesión y se encargará de inicializar el menú, configurar omnichannel, realizar comprobaciones de términos y condiciones, integrar Firebase y otros aspectos esenciales.

Además, se encargará de definir el header de la aplicación, incluyendo el avatar del usuario y el menú de configuración correspondiente.

CloudFrameWorkInterface.initAppInterface();

Este método se utiliza para gestionar el menú lateral.

La clase cuenta con tres métodos:

• loadMainMenu()
  
• ​composeMainMenuHtml()
  
• activateCmmdClick()
  

El método realiza una petición al servidor para obtener el menú correspondiente a la plataforma. Utiliza como parámetros de consulta la configuración definida en `CloudFrameWorkInterface.cloudplatform`. Además, el método permite un parámetro opcional que indica si se debe reiniciar la localización del menú.

Este método devuelve una promesa que contendrá el resultado de la consulta.

Variables:

CloudFrameWorkInterface.mainMenu.loadMainMenu()
//Output: Promise

Este método crea el menú correspondiente al ‘Área’ activa. El código generado será una lista en formato HTML (<ul></ul>), que incluirá tanto el menú principal como los submenús.

Ejemplo:

CloudFrameWorkInterface.mainMenu.composeMainMenuHtml()

Este método permite que cada enlace del menú, se abra en una nueva pestaña, utilizando la combinación de tecla CMD + CLICK.

CloudFrameWorkInterface.mainMenu.activateCmmdClick()

Este método nos permite cambiar entre las distintas áreas de la plataforma. Cada área, representa una sección del ERP a la cual se podrá acceder en caso de tener los permisos correspondientes.

Variables:

CloudFrameWorkInterface.changeOrg(0,null,'https://mynewpage.page/');

Este método se usa principalmente para la gestión de plantillas HTML, permitiendo la carga de plantillas desde una URL.

Esta clase cuenta con siete métodos para gestionar las plantillas del CFO:

• ​renderFromTemplate(templateUrl, data, mode, id, call_func)
  
• renderFromClientsTemplates(templateUrl, data, mode, id, call_func)
  
• renderFromScript(idScript, data, mode, id, call_func)
• load(url, node)
• render(html, data, mode, id, call_func)
• pageSetup(page_log)
• getParametersByName()

El método renderiza una plantilla en un elemento del DOM identificado por la variable ‘id’ y adjunta la información proporcionada en ‘data’.

Variables:

CloudFrameWorkInterface.template.renderFromTemplate('https://app.cloudframework.app/404.html',{},'html','js-page-content',()=>{console.log('Termino la carga')})

El método renderiza una plantilla en un elemento del DOM, utilizando la URL especificada en la variable templateUrl. Esta plantilla puede ser un archivo HTML o un archivo HTM del Framework Mustache.

La diferencia clave entre esta función y CloudFrameWorkInterface.template.renderFromTemplate es que aquí se puede cargar una plantilla local desde la ruta ‘/ajax/client_renders/’

Variables:

CloudFrameWorkInterface.template.renderFromClientsTemplates('archive.html',{},'html','js-page-content',()=>{console.log('Termino la carga')})

El método cargará una plantilla Mustache (predefinida*) utilizando el parámetro idScript como referencia.

* Nota: En el archivo cfo_mustache_templates.htm se encuentra la lista con todas las plantillas predefinidas disponibles.

Variables:

CloudFrameWorkInterface.template.renderFromScript('template_right_modal',{},'html','js-page-content',()=>{console.log('Termino la carga')})

El método carga un archivo desde la variable ‘url’ en un elemento del DOM definido en la variable ‘node’

Variables:

CloudFrameWorkInterface.template.load('https://core20.web.app/ajax/tpl/cfo_mustache_templates.htm', 'cfo_mustache_scripts')

El método cargará código HTML en un elemento del DOM, identificado por la variable ‘id’ y adjuntará la información proporcionada en ‘data’.

Variables:

CloudFrameWorkInterface.template.render('<div>Test<div>',{},'html','js-page-content',()=>{console.log('Termino la carga')})

Este método es crucial en cada nueva pantalla. Al crear o navegar a una nueva pantalla, debes ejecutar esta función de forma inicial. Con esto, se garantizará el correcto funcionamiento del sistema.

Variables:

CloudFrameWorkInterface.template.pageSetUp('My cloudframework page')

Al ejecutar este método, obtendrás un objeto con los parámetros de la URL en la página actual.

//Ejemplo de URL http://web.com/app.html#https://start.com/dashboard.html?param=user_config&otherparam=admin 

CloudFrameWorkInterface.template.getUrlParams() 

//Output {param: 'user_config', otherparam: 'admin'}

Esta función está en desuso.

Este método, imprime en la consola una línea de error.

Variables:

CloudFrameWorkInterface.error('Título del error', {'message': 'Esto es un error', code: 400}); 

//Output: [CloudFrameWorkInterface.error] Título del error {message: 'Esto es un error', code: 400}

Este método utiliza Core.log.print que está en desuso.

Este método renderizará un mensaje de error en un elemento del DOM. Aunque está diseñado para las respuestas de la API, también puede utilizarse en cualquier otro contexto.

Ejemplo:

Variables:

CloudFrameWorkInterface.renderAPIError({ code: 'not-found', errors: ['Not Found [Info not found]','Second error'] }, 'app')

Esta función está en desuso.

Al ejecutar este método, se mostrará una ventana estilo ‘toast’ en la que podremos presentar información al usuario de manera breve y no intrusiva. Este enfoque es útil para notificar sobre eventos, errores o cualquier otro mensaje relevante.

Ejemplo:

Variables:

CloudFrameWorkInterface.newAlertBox('success', 'Este es el titulo', 'Este es el mensaje',5, 'https://app.cloudframework.app/');

Al ejecutar este método, podremos copiar un texto al portapapeles.

Ejemplo:

Variables:

CloudFrameWorkInterface.copyToClipBoard('Texto para el portapapeles', 'Listo copiaste')

Este método retorna la ruta base del proyecto. Su función principal es permitirnos identificar si estamos ejecutando el proyecto en local o en el servidor.

Esto es útil para adaptar el comportamiento de la aplicación según el entorno en el que se encuentre.

CloudFrameWorkInterface.getServerUrlFromHash(); 
//Output: Desde el Hosting https://core20.web.app 
//Output: Desde el servidor local http://localhost:5000

Este método permite agregar la opción de emisor de eventos a un objeto. Recibe como parámetro un objeto al cual se le agregará la capacidad de emitir, crear o eliminar eventos. Es útil para implementar patrones de observación y notificación en tu aplicación.

Variables:

//Crear emisor
let emisor = {};
CloudFrameWorkInterface.cfiEmitter(emisor);

//Emitir un evento:
emisor.emit('something_loaded');

//Esperar que se emita en evento
emitter.on('something_loaded', () => {    
    // Hacer algo al recibir la notificación del evento.
})

Este método, inicia la conexión con firebase. (SOLO PARA PROYECTO CLOUDFRAMEWORK)

Es complementario a los métodos:

• CloudFrameWorkInterface.getFirebaseJWT()
• CloudFrameWorkInterface.firebaseCustomAuth()

El método hace una consulta a la API de CFW para solicitar un token de autenticación. Este token será usado para la conexión del usuario con Firebase.

Este método conecta al usuario a la plataforma de Firebase, usando un token personalizado. Este token permite al usuario acceder al Firestore.

El token se crea desde CloudFrameWorkInterface.getFirebaseJWT()

El método inicia la recepción de notificaciones push en el navegador. Al ejecutarlo, se le pedirá al usuario permisos para mostrar notificaciones.

Esta clase proporciona un conjunto de funciones utilitarias diseñadas para reutilizar tareas comunes y simplificar el código.

En total, cuenta con 16 métodos utilitarios que abordan diversas funcionalidades.

• ​dateToTimezone(date, in_format, out_format)
  
• timezoneToUTC(date, in_format, out_format)
  
• slugify(text)
  
• removeHtmlCode(html)
  
• getInitials(glue)
  
• generateTextAvatar(fullName, color)
  
• loadScripts(urls)
• loadCss(url, forceReload, id)
  
• isColor(color, returnType)
  
• hexToRgb(hex)
  
• hexToRgba(hex, opacity)
  
• rgbToHex(color)
  
• colorReduceBrightness(color, percent, exitFormat)
  
• colorIncreaseBrightness(color, percent, exitFormat)
  
• deleteElementFromDomObserver(idElemento, callbackFunction)
  
• anchor(id)
  

El método dateToTimezone convierte una cadena de caracteres o una variable de tipo Date en una fecha. La fecha se ajustará de UTC a la zona horaria definida en Core.user.info.User.UserTimeZone

Variables:

CloudFrameWorkInterface.utils.dateToTimezone(new Date(), '', 'D MMM YY')
//Output: '11 jul. 24'

CloudFrameWorkInterface.utils.dateToTimezone('11 jul. 24', 'D MMM YY', 'DD-MM-YYYY')
//Output: '11-07-2024'

El método convierte una cadena de caracteres o una variable de tipo Date en una fecha. La fecha se ajustará de la zona horaria local a UTC.

Variables:

CloudFrameWorkInterface.utils.timezoneToUTC('2022-07-10 12:00', 'YYYY-MM-DD HH:mm', 'DD-MM-YYYY HH:mm') 
//Output: '10-07-2022 10:00' 
CloudFrameWorkInterface.utils.timezoneToUTC(new Date(), '', 'DD-MM-YYYY HH:mm') 
//Output: '10-07-2022 21:50'

El método convierte una cadena de caracteres en una versión más legible para las URLs. Esto es útil para asegurarte de que los caracteres especiales se codifiquen correctamente y no causen problemas al formar parte de una dirección web.

Variables:

CloudFrameWorkInterface.utils.slugify('the !cloud framework#$! @!experience') //Output: 'the-cloud-framework-experience'

El método elimina todo el código HTML presente en una cadena de caracteres. Esto es útil para asegurarte de que el texto no contenga etiquetas HTML y sea adecuado para su uso en contextos donde se requiere texto plano.

Variables:

CloudFrameWorkInterface.utils.removeHtmlCode('<div> <h1>CFW</h1> <p>Cloud framework </p></div> Eliminado') 
//Output 'eliminado'

Esta función capitaliza la primera letra de cada parte de un string, separado por un delimitador y las combina. 

Variables:

CloudFrameWorkInterface.utils.getInitials('Cloud Framework')
//Output 'CF'

Este método genera una imagen en formato Base64 para un avatar, basado en el nombre y el color proporcionados

Ejemplo:

Variables:

CloudFrameWorkInterface.utils.generateTextAvatar('Heysser aguilera', '#674EA7')
//Output 'data:image/png;base64,iVBORw0KGgoAAAAN...

Este método nos permite cargar multiples scripts de forma asincrónica. Si el script ya está cargado, se resuelve inmediatamente. 

El método devuelve una promesa que se resuelve cuando se cargan todos los scripts.

Variables:

CloudFrameWorkInterface.utils.loadScripts(['https://cfw-cdn.web.app/libs/vuex/vuex.min.js', 'https://js.stripe.com/v3/' ])

Este objeto nos permite extraer los valores presentes entre dos puntos de una cadena de caracteres.

Los pasos son los siguientes:

1. Definir la cadena de caracteres CloudFrameWorkInterface.utils.getFromBetween.string = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
   
2. Ejecutar CloudFrameWorkInterface.utils.getFromBetween.getFromBetween('ipsum', 'consectetur') 
3. Resultado: ' dolor sit amet, '

Variables:

Este método nos permite cargar un archivo CSS. Si el script ya está cargado, no se recarga.

Variables:

CloudFrameWorkInterface.utils.loadCss('https://cfw-cdn.web.app/libs/vuetify2/vuetify@2.6.15_dist.min.css');

Este método nos permite cargar un archivo CSS. Si el script ya está cargado, no se recarga.

Variables:

CloudFrameWorkInterface.utils.loadCss('https://cfw-cdn.web.app/libs/vuetify2/vuetify@2.6.15_dist.min.css');

Este método convierte un hexadecimal a formato RGB

Variables:

CloudFrameWorkInterface.utils.hexToRgb('#FF0000'); 
// Output: "rgb(255, 0, 0)"
CloudFrameWorkInterface.utils.hexToRgb('#F00'); 
// Output: "rgb(255, 0, 0)"
CloudFrameWorkInterface.utils.hexToRgb('invalid_hex_code'); 
// Output: null

Este método convierte un hexadecimal a formato RGBa

Variables:

CloudFrameWorkInterface.utils.hexToRgba('#FF0000',0.2); 
// Output: "rgb(255, 0, 0, 0.2)"

Este método convierte un valor RGB a formato hexadecimal.

Variables:

CloudFrameWorkInterface.utils.hexToRgba('#FF0000',0.2); 
// Output: "rgb(255, 0, 0, 0.2)"

Este método reduce el brillo de un color en formato RGB o Hexadecimal.

Variables:

CloudFrameWorkInterface.utils.colorReduceBrightness('rgb(255,0,0)',0.1);
// Output: '#ff0000'
CloudFrameWorkInterface.utils.colorReduceBrightness('rgb(255,0,0)',1);
// Output: '#fc0000'

Este método reduce el brillo de un color en formato RGB o Hexadecimal.

Variables:

CloudFrameWorkInterface.utils.colorIncreaseBrightness('rgb(255,0,0)',0.1);
// Output: '#ff0000'
CloudFrameWorkInterface.utils.colorIncreaseBrightness('rgb(255,0,0)',1);
// Output: '#ff0303'

Este método activa un observador de cambios, en el hijo de un nodo del elemento del DOM.

Variables:

CloudFrameWorkInterface.utils.deleteElementFromDomObserver('id_element', ()=>{
    console.log("Child changed")
});

Este método crea un scroll a la parte superior de un elemento del DOM.

Variables:

CloudFrameWorkInterface.utils.anchor('node_ecm_rows');

Este método nos permite mostrar una ventana de confirmación o de notificación.

Variables:

Ejemplo:

// Type: Notificación
CloudFrameWorkInterface.confirmationDialog({
    title:'Notificación',
	type: 'dialog', 
	message: 'Esta es una ventana de notificación', 
	callback: ()=>{}, 
	label_confirm: 'Aceptar',
})

// Type: Confirmation
CloudFrameWorkInterface.confirmationDialog({
    title:'Confirmación',
	type: 'confirm', 
	message: 'Esta es una ventana de Confirmación', 
	callback: (event)=>{ console.log('Confirmed modal', event)}, 
	label_confirm: 'OK', 
	label_cancel: 'Cancelar' 
})

 Con este método podemos obtener el archivo de configuración de la plataforma actual. La respuesta será una promesa.

CloudFrameWorkInterface.getPlatformAssets()

//Output
{
"cloudplatform": "cloudframework",
"name": "CloudFrameWork",
"cfi_api": "https://api.cloudframework.io/core/cfi",
"cfi_login_api": "https:///api.cloudframework.io/siginup/v1/cloudframework/in",
"url_logo": "https://storage.googleapis.com/cloudframework-public/images/cloudframework/logo-cloudframework.svg",
"url_favicon": "https://storage.googleapis.com/cloudframework-public/static/app/2021/img/logo-cfw-favicon.png?v2",
"url_backgrounds": [
"https://storage.googleapis.com/cloudframework-public/images/cloudframework/cloudframework-slider1.jpg",
"https://storage.googleapis.com/cloudframework-public/images/cloudframework/cloudframework-slider2.jpg"
    ],
"theme_color": "#0fcad8",
"menu_config": {
"theme": "custom",
"_text_color": "#333",
"text_active_color": "#77d3da",
"_background_color": "#8edde5",
"_icon_color": "#5A4FA2"
    },
"allow_mail_recovery": true,
"allow_login_password": true,
"allow_login_google": false,
"allow_login_facebook": false,
"recovery_password_method": "code",
"allow_login_twitter": false,
"password_strong_validation": true,
"version": "20240708104330",
"portal_users": false,
"portal_users_client_id": null,
"http_referer": "http://localhost:9998/",
"hostname": "localhost",
"marketplace": [ ]
}

 Este método carga en cache y en el Core, la configuración inicial de la plataforma desde la API. La respuesta es una promesa.

CloudFrameWorkInterface.setPlatform()

//Output
{
"cloudplatform": "cloudframework",
"name": "CloudFrameWork",
"cfi_api": "https://api.cloudframework.io/core/cfi",
"cfi_login_api": "https:///api.cloudframework.io/siginup/v1/cloudframework/in",
"url_logo": "https://storage.googleapis.com/cloudframework-public/images/cloudframework/logo-cloudframework.svg",
"url_favicon": "https://storage.googleapis.com/cloudframework-public/static/app/2021/img/logo-cfw-favicon.png?v2",
"url_backgrounds": [
"https://storage.googleapis.com/cloudframework-public/images/cloudframework/cloudframework-slider1.jpg",
"https://storage.googleapis.com/cloudframework-public/images/cloudframework/cloudframework-slider2.jpg"
    ],
"theme_color": "#0fcad8",
"menu_config": {
"theme": "custom",
"_text_color": "#333",
"text_active_color": "#77d3da",
"_background_color": "#8edde5",
"_icon_color": "#5A4FA2"
    },
"allow_mail_recovery": true,
"allow_login_password": true,
"allow_login_google": false,
"allow_login_facebook": false,
"recovery_password_method": "code",
"allow_login_twitter": false,
"password_strong_validation": true,
"version": "20240708104330",
"portal_users": false,
"portal_users_client_id": null,
"http_referer": "http://localhost:9998/",
"hostname": "localhost",
"marketplace": [ ]
}

Este método crea y agrega variables de CSS para el tema de SmartAdmin. Estas variables se crean en el :root de la cabecera HTML.

Variables:

Ejemplo:

CloudFrameWorkInterface.  calculateColors('#6610f2')

Este método convierte un hexadecimal a formato HSL

Variables:

CloudFrameWorkInterface.hexToHSL('#6610f2');
// Output: "263,89.7%,50.6%"

Este método convierte un JSON en código HTML, creando una etiqueta <span> para cada ‘key’ y otra para cada ‘value’ del JSON.

Variables:

CloudFrameWorkInterface.jsonPrettyPrint({"key1": 'text example',"key2": 'test text description'})

//Output '{\n   <span class="json-key" style="color: #333">test1</span>: <span class="json-string" style="color: #27a9b1">"12345"</span>,\n   <span class="json-key" style="color: #333">test2</span>: <span class="json-string" style="color: #27a9b1">"test text description"</span>\n}'

Este método facilita la creación y manejo de modales en la parte central de la aplicación. Dichas modales pueden mostrar contenido html proporcionando en la variable 'payload.content' o, pueden ser utilizadas para cargar una pagina desde una URL.

[2024-09-13]

Se añade la posibilidad de tener múltiples modales abiertas al mismo tiempo en la plataforma.

Variables: 

CloudFrameWorkInterface.centerModal({
    title:'Modal title', // Modal title
    icon:'fa-user', // Modal icon
    modal_size:'xl', // Modal sizes: 'sm': small, null: default md size , 'lg': large, 'xl': extra large, 'xxl': 90vw
    content: 'Modal html content' // html content for the modal    
}); 

El método verifica si la plataforma tiene un script de Tag Manager definido. Si está definido, se agregará en la cabecera.

La verificación se realiza comprobando la variable CloudFrameWorkInterface.platformData.platform.tagmanager

CloudFrameWorkInterface.checkTagManagerScript(); 

El método verifica si la plataforma tiene activo un pie de página personalizado. Si está definido, se agregará en la parte inferior de la página.

La verificación se realiza comprobando la variable CloudFrameWorkInterface.platformAssets.custom_footer

CloudFrameWorkInterface.checkCustomFooter(); 

Este método verifica si el usuario tiene una subscripción activa o no en la plataforma. El método calculará la diferencia de tiempo entre la fecha actual y una fecha límite especificada; en función de esta diferencia, generará un mensaje informativo del tiempo restante de subscripción.

Los mensaje varian según el tiempo restante. 

• Un día o más: 'Falta(n) X día(s)'
  
• Menos de un día: 'Falta(n) X hora(s)'
• Tiempo expirado: ''Periodo agotado. Contacte con CloudFramework

CloudFrameWorkInterface.checkUnsubscribeMessage(); 

Este método, nos permite crear y cargar una aplicación Web usando VUE, dentro del sistema de CFW.

Esta clase cuenta con una variable y un método para la carga de scripts de forma dinámica.

Archivo de ejemplo:

Este método eliminará de la pagina actual el fragmento de la URL, esta acción no hará una recarga de la página.

//Original URL 
https://app.cloudframework.app/app.html#https://core20.web.app/ajax/cfa.html?api=%2Ferp%2Fpeople-pannels&l=developersnbsp__a__0

CloudFrameWorkInterface.cleanUpUrlVariables(); 

//Output 
https://app.cloudframework.app/app.html

La ejecución de este método permite iniciar sesión utilizando dos parámetros. Este método retornará una promesa y, para ejecutarla de forma satisfactoria debemos incluir en la URL los parámetros ‘ClientId’ y ‘ERPCode’.

//Example URL 
https://app.cloudframework.app/app.html?ClientId=1234&ERPCode=code1234

//Method execution
CloudFrameWorkInterface.signinWithERPCode(); 

//Output 
//Successful promise: Redirection to Dashboard Area.
//Unsuccessful promise: Redirection to Error Area.

La ejecución de este método permite iniciar sesión, usando el parámetro ERPAccessToken definido en la URL.

El método retornará una promesa con la validación de ERPAccessToken

//Example URL 
https://app.cloudframework.app/app.html?ERPAccessToken=ERP_ACCESS_CODE

//Method execution
CloudFrameWorkInterface.signinWithERPAccessToken(); 

//Output 
//Successful promise: Redirection to Main Area.
//Unsuccessful promise: Error page

Este método se usa principalmente para cargar scripts en formato '.js'.

Esta clase cuenta con cinco métodos para gestionar los scripts

• ​init(payload)
  
• getSrcBase(src)
  
• documentScripts()
• documentScriptBases()
• _load()

Con este método podremos cargar una lista de scripts. Para ello, se debe pasar una arreglo de tipo String, en la variable 'payload.scripts' a la función: CloudFrameWorkInterface.scriptsLoader.init(payload)

Variables:

CloudFrameWorkInterface.scriptsLoader.init({
    callback: () => {},
    scripts: ['https://cfw-cdn.web.app/libs/vee-validate/vee-validate@3.4.14.min.js']})

El método toma un string en el parámetro 'src' y devuelve un substring con la ultima ocurrencia del carácter '/'

Variables:

CloudFrameWorkInterface.scriptsLoader.getSrcBase('https://cfw-cdn.web.app/libs/vee-validate/vee-validate@3.4.14.min.js')
//Output 'vee-validate@3.4.14.min.js'

El método retorna todos los scripts que ya están cargados en la página.

CloudFrameWorkInterface.scriptsLoader.documentScripts()
//Output ['https://cfw-cdn.web.app/libs/vuedraggable/sortable.min.js', ...]

El método retorna un string con el nombre y formato de todos los scripts cargados en la página.

CloudFrameWorkInterface.scriptsLoader.documentScriptBases()
//Output ['sortable.min.js', 'jquery.atwho.min.js', ...]

El método hará la carga de todos los scripts almacenados en el Array CloudFrameWorkInterface.scriptsLoader.payload. En caso de que ya estén en caché, no se hará una recarga.

CloudFrameWorkInterface.scriptsLoader.documentScriptBases()
//Output ['sortable.min.js', 'jquery.atwho.min.js', ...]