Métodos Lappiz
Métodos predefinidos.
Los métodos de Lappiz se crean en los espacio de eventos o en la configuración de controles personalizados.
getUser
getUser
Permite obtener información del usuario logueado.
getEntityId
getAppViewId
getRowId
getNewId
getCurrentItem
getCurrentItem
Permite acceder a la colección de atributos del registro que se desea editar. Los parámetros de retorno no:
dataItem:Objeto que contiene los atributos con los datos del item que se está editando.
parent:Retornar la colección de objetos del padre dado el caso que se esté ejecutando el método desde un detalle.
getCampoById
setFieldValue
setFieldValue
Permite asignar un valor a un campo. Recibe como parámetros:
fieldId: campo al cual se le asignará un valor.
value: valor a asignar.
isToDetails: true si el campo esta en una vista tipo detalles, false sino.
toDetails:Un objeto, el cual lleva la parametrización en caso que el control a deshabilitar no esté en la vista principal, el objeto toDetails tiene las siguientes propiedades:
1.CampoParentId: El campo que agrupa la configuración de la vista detalles.
2. EventTypeName: El tipo de evento a ejecutar, si se deja vacio pone por defecto FormLoaded.
3. EventType: Posibles valores: Form, Control, si se deja vacio pone por defecto Form.
getFieldValue
getFieldValue
Permite obtener el valor de un campo. Recibe como parámetros:
fieldId:Id del campo que se desea obtener su valor.
disableField
disableField.
Permite deshabilitar un campo para no permitir su edición.
fieldId: campo al cual se desea desabilitar o habilitar.
value: true si se desea deshabitar, false sino.
toDetails:Un objeto, el cual lleva la parametrización en caso que el control a deshabilitar no esté en la vista principal, el objeto toDetails tiene las siguientes propiedades:
1. campoParentId:El campo que agrupa la configuración de la vista detalles.
2. EventTypeName:El tipo de evento a ejecutar, si se deja vacío pone por defecto FormLoaded.
3. EventType:Posibles valores: Form, Control, si se deja vacío pone por defecto Form.
requireField
requireField
Permite indicarle al sistema que debe volver obligatorio un campo según alguna regla de negocio. Los parámetros que recibe son:
campoId: Id del campo que se desea volver obligatorio.
status: True o false según el caso de obligatoriedad.
visibilityField
visibilityField
Permite indicarle al sistema que debe mostrar u ocultar un campo según alguna regla de negocio. Los parámetros que recibe son:
campoId: Id del campo que se desea ocultar.
status: True o false según el caso de mostrar u ocultar.
visibilitySection
visibilitySection
Permite indicarle al sistema que debe mostrar u ocultar una sección según alguna regla de negocio. Los parámetros que recibe son:
sectionId: Id de la sección que se desea ocultar.
status: True o false según el caso de mostrar u ocultar.
visibilityLoader
disableAction
disabledAction
Permite deshabilitar una acción o en su caso contrario, activarla. Recibe como parámetros:
ActionId:Corresponde al Id de la acción que se desea deshabilitar.
Status:Se especifica true para habilitar y false para deshabilitar.
isDisableField
goLocation
goLocation
Permite indicarle al sistema que debe dirigirse a otra vista, ya sea tipo lista o formulario. Este método permite transportar parámetros por medio de la URL adicionales a los parámetros fijos, los parámetros fijos son:
viewName: Nombre de la entidad donde se encuentra la vista.
entityId: Id de la entidad donde se encuentra la vista a la que se desea navegar.
appViewId: Id de la vista donde se desea ingresar.
rowId: Id del registro que se desea abrir en modo edición.
sendEmail
sendEmail
Permite enviar correos electrónicos a múltiples destinos desde cualquier evento. Recibe como parámetros:
smtpsender:Se debe enviar la palabra reservada "lappiz" o "aws" dependiendo del proveedor de envio de correo.
to:String con los correos a los que se les desea enviar el email separados por comas.
subject: Es el asunto del correo.
text: Es el cuerpo del correo.
html: Es como desea que se visualice el cuerpo del correo.
attachments: Arreglo de datos adjuntos.
cc: Arreglo de correos a enviar con copia pública.
bcc: Arreglo de correos a enviar con copia oculta.
Para más información de los attachments, visitar la documentación de la librería nodemailer: https://nodemailer.com/message/attachments/
execQuery
execQuery
Permite hacer una petición para ejecutar queries a la base de datos por medio del API transaccional. Recibe como parámetro:
StringQuery:Variable con la sentencia SQl a ejecutar.
execSP
execSP
Permite hacer una petición para ejecutar procedimientos almacenados de la base de datos por medio del API transaccional. Recibe como parámetros:
SPName:Nombre del procedimiento almacenado a ejecutar.
ParamsArray:Arreglo con la colección de parámetros que reciba el procedimiento almacenado creado por el desarrollador.
openCustomModal
openCustomModal
Método encargado de abrir una modal. Recibe como parámetros:
config:Objeto que tiene la configuracion de lo que va a mostrar la modal
done: Función que se ejecutará cuando den click en aceptar.
cancel: Función que se ejecutará cuando den click en cancelar.
closeModal
closeModal
Permite cerrar la modal del detalle en el que nos encontramos.
sendSMS
sendSMS
Método encargado de realizar envío de mensajes via SMS. Los parámetros que recibe son:
destination: Número de teléfono a enviar el mensaje. Se debe enviar con el indicativo del país. Ejemplo: '573175758621'.
message: Mensaje a enviar.
sendPush
sendPush
Método encargado de realizar envío de mensajes via push. Los parámetros que recibe son:
userId: Id del usuario al que se le enviará la notificación.
dataMessage: Es el objeto de configuración para el envío del mensaje. Para mayor documentación, revisar la documentación de la librería: https://developer.mozilla.org/en-US/docs/Web/API/Notification/Notification
isReadyForm
isReadyForm
Permite indicarle al sistema cuando esta listo el formulario para trabajar en el:
status: True o false según el caso de mostrar u ocultar.
execLF
execLF
Ejecuta una lappiz function
nameFunction : Nombre de la funcion, tipo de dato string.
lappizFunctionId : Id de la lappiz function el cual se entrega en la url de la configuracion de esta misma, tipo de dato string.
body: Cuerpo que requiere la lappiz function para su correcto funcionamiento, tipo de datos Object.
method: Método HTTP por el que viaja la petición. Disponible GET o POST
Cancelar transacciones en eventos.
Los eventos que soportan cancelar transacciones con la propiedad e.cancelson ItemCreating, ItemEditing, ItemSaving.
e.cancel = true;
Si se están usando operaciones asíncronas y se utiliza la instrucción dentro de la respuesta no va a funcionar, para poder cancelar dicha operación debe ser sincronía.
Last updated
Was this helpful?