Clase para gestión de notificaciones. Más...

Diagrama de herencia de sage.ew.functions.Notifica

Métodos públicos
delegate void	ShowMessage_Handler (object sender, string texto, string caption, MessageBoxButtons buttons, MessageBoxIcon icon, MessageBoxDefaultButton defaultButton, out DialogResult dialogResult)
	Delegado de mostrar notificación.

bool	_Add (Notificacion toNotificacion)
	Añade una notificacion al sistema.

bool	_Add (string tcCategoria, string tcNombre, string tcAmpliacion="", string tcDatos="", string tcLibreria="", string tcClase="", NotificaIconos toIcono=NotificaIconos.info, bool tlAccion=false, string tcImagen="", bool tlPermanente=false, bool tlVisto=false, string tcUsuario="", bool tbPresentar=false, string tcReiniciar="")
	Añade una notificacion al sistema.

bool	_Add (string tcCategoria, string tcNombre, string tcAmpliacion="", string tcDatos="", string tcLibreria="", string tcClase="", string tcIcono="", bool tlAccion=false, string tcImagen="", bool tlPermananete=false, bool tlVisto=false, string tcUsuario="", bool tbPresentar=false, string tcReiniciar="")
	Método responsable de añadir notificaciones del sistema. Genera un registro en COMUNES!NOTIFICA PE-100247.

bool	_Update (Notificacion toNotificacion)
	Actualiza el registro.

bool	_Get (int tnId, out Notificacion toNotificacion)
	Método para devolver una notificacion segun su id.

IEnumerable< Notificacion >	_GetByCategoria (string tcCategoria)
	Obtiene las notificaciones por categoría.

bool	_Delete (int tnId)
	TODO : Método para borrar un registro de notificación.

bool	_DeleteAll (int tnDias=-30)
	Borra todos los registros con mas de tnDias dias de antiguedad.

void	_UpdateAllVisto ()
	Marca todas las notificaciones como leídas.

void	Dispose ()
	Public implementation of Dispose pattern callable by consumers.

Métodos públicos estáticos
static void	ForceNotificaTimer ()
	Funcion que permite mostrar por pantalla notificaciones pendientes de aviso al usuario.

Métodos protegidos
virtual void	Dispose (bool disposing)
	Protected implementation of Dispose pattern.

Propiedades
INotificacionRepository	Repositorio = DependencyInjector.Instance.Retrieve<INotificacionRepository>() `[get, set]`
	Instancia para gestionar el repositorio de datos.

static Notifica	_This `[get, set]`
	Instancia estática del objeto usuario con los datos del usuario actual (wc_usuario)

Descripción detallada

Clase para gestión de notificaciones.

Definición en la línea 629 del archivo Notifica.cs.

Documentación de funciones miembro

◆ _Add() [1/3]

bool sage.ew.functions.Notifica._Add ( Notificacion toNotificacion )

inline

Añade una notificacion al sistema.

Parámetros

toNotificacion Objeto de la notificacion

Devuelve: true si inserta el registro en COMUNES!NOTIFICA, false en caso contrario

Definición en la línea 913 del archivo Notifica.cs.

◆ _Add() [2/3]

bool sage.ew.functions.Notifica._Add	(	string	tcCategoria,
		string	tcNombre,
		string	tcAmpliacion = "",
		string	tcDatos = "",
		string	tcLibreria = "",
		string	tcClase = "",
		NotificaIconos	toIcono = NotificaIconos::info,
		bool	tlAccion = false,
		string	tcImagen = "",
		bool	tlPermanente = false,
		bool	tlVisto = false,
		string	tcUsuario = "",
		bool	tbPresentar = false,
		string	tcReiniciar = "" )

inline

Añade una notificacion al sistema.

Parámetros

tcCategoria	Nombre de la categoria que se quiere asignar a la notificación
tcNombre	Nombre resumido de la notificación
tcAmpliacion	Descripción ampliada de la notificación
tcDatos	Campo libre para datos reutilizables por la funcion _Notify_Click() de la notificacion (XML, JSON, o como sea)
tcLibreria	Libreria donde se encontrará el iciono y el método _NotifyClick() de la notificación
tcClase	Nombre de la clase que contiene el método _NotifyClick()
toIcono	Enum tipo NotificaIconos con el tipo de icono predefinido
tlAccion	Booleano que indica si hay _NotifyClick() específica de la clase
tcImagen	Imagen asociada a la acción
tlPermanente	PE-103962 Determinará si el registro debe ser perdurable en el tiempo
tlVisto	Determinará si el registro se ha leido o no
tcUsuario	Determinará el usuario destinatario de la notificación
tbPresentar	Indicaremos si la notificación debe presentar mensaje
tcReiniciar	Indicaremos la condición para reiniciar

Devuelve: true si inserta el registro en COMUNES!NOTIFICA, false en caso contrario

Definición en la línea 936 del archivo Notifica.cs.

◆ _Add() [3/3]

bool sage.ew.functions.Notifica._Add	(	string	tcCategoria,
		string	tcNombre,
		string	tcAmpliacion = "",
		string	tcDatos = "",
		string	tcLibreria = "",
		string	tcClase = "",
		string	tcIcono = "",
		bool	tlAccion = false,
		string	tcImagen = "",
		bool	tlPermananete = false,
		bool	tlVisto = false,
		string	tcUsuario = "",
		bool	tbPresentar = false,
		string	tcReiniciar = "" )

inline

Método responsable de añadir notificaciones del sistema. Genera un registro en COMUNES!NOTIFICA PE-100247.

Parámetros

tcCategoria	Nombre de la categoria que se quiere asignar a la notificación
tcNombre	Nombre resumido de la notificación
tcAmpliacion	Descripción ampliada de la notificación
tcDatos	Campo libre para datos reutilizables por la funcion _Notify_Click() de la notificacion (XML, JSON, o como sea)
tcLibreria	Libreria donde se encontrará el iciono y el método _NotifyClick() de la notificación
tcClase	Nombre de la clase que contiene el método _NotifyClick()
tcIcono	Nombre del recurso gráfico que se mostrará en la grid de notificaciones
tlAccion	Booleano que indica si hay _NotifyClick() específica de la clase
tcImagen	Imagen asociada a la acción
tlPermananete	PE-103962 Determinará si el registro debe ser perdurable en el tiempo
tlVisto	Determinará si el registro se ha leido o no
tcUsuario	Determinará el usuario destinatario de la notificación
tbPresentar	indicaremos si la notificación debe presentar mensaje
tcReiniciar	indicaremos la condición para reiniciar

Devuelve: true si inserta el registro en COMUNES!NOTIFICA, false en caso contrario

Definición en la línea 962 del archivo Notifica.cs.

◆ _Delete()

bool sage.ew.functions.Notifica._Delete ( int tnId )

inline

TODO : Método para borrar un registro de notificación.

Parámetros

tnId	Id de la notificacion que se quiere borrar

Devuelve: true si se ha borrado con éxito, false en caso contrario

Definición en la línea 1024 del archivo Notifica.cs.

◆ _DeleteAll()

bool sage.ew.functions.Notifica._DeleteAll ( int tnDias = -30 )

inline

Borra todos los registros con mas de tnDias dias de antiguedad.

Parámetros

tnDias Dias de antiguedad a partir de los quales se borraran la notificaciones

Devuelve

Definición en la línea 1034 del archivo Notifica.cs.

◆ _Get()

bool sage.ew.functions.Notifica._Get	(	int	tnId,
		out Notificacion	toNotificacion )

inline

Método para devolver una notificacion segun su id.

Parámetros

tnId	Id de la notificación
toNotificacion	Objeto notificacion encontrado

Devuelve: true si se encuetra el registro, false en caso contrario

Definición en la línea 1003 del archivo Notifica.cs.

◆ _GetByCategoria()

IEnumerable< Notificacion > sage.ew.functions.Notifica._GetByCategoria ( string tcCategoria )

inline

Obtiene las notificaciones por categoría.

Parámetros

tcCategoria Categoría de la que obtener las notificaciones

Devuelve

Definición en la línea 1014 del archivo Notifica.cs.

◆ _Update()

bool sage.ew.functions.Notifica._Update ( Notificacion toNotificacion )

inline

Actualiza el registro.

Parámetros

toNotificacion

Devuelve

Definición en la línea 992 del archivo Notifica.cs.

◆ _UpdateAllVisto()

void sage.ew.functions.Notifica._UpdateAllVisto ( )

inline

Marca todas las notificaciones como leídas.

Devuelve

Definición en la línea 1043 del archivo Notifica.cs.

◆ Dispose() [1/2]

void sage.ew.functions.Notifica.Dispose ( )

inline

Public implementation of Dispose pattern callable by consumers.

Definición en la línea 1057 del archivo Notifica.cs.

◆ Dispose() [2/2]

virtual void sage.ew.functions.Notifica.Dispose ( bool disposing )

inlineprotectedvirtual

Protected implementation of Dispose pattern.

Parámetros

disposing

Definición en la línea 1067 del archivo Notifica.cs.

◆ ForceNotificaTimer()

static void sage.ew.functions.Notifica.ForceNotificaTimer ( )

inlinestatic

Funcion que permite mostrar por pantalla notificaciones pendientes de aviso al usuario.

183853

Definición en la línea 683 del archivo Notifica.cs.

◆ ShowMessage_Handler()

delegate void sage.ew.functions.Notifica.ShowMessage_Handler	(	object	sender,
		string	texto,
		string	caption,
		MessageBoxButtons	buttons,
		MessageBoxIcon	icon,
		MessageBoxDefaultButton	defaultButton,
		out DialogResult	dialogResult )

Delegado de mostrar notificación.

Documentación de propiedades

◆ _This

Notifica sage.ew.functions.Notifica._This

staticgetset

Instancia estática del objeto usuario con los datos del usuario actual (wc_usuario)

Definición en la línea 658 del archivo Notifica.cs.

◆ Repositorio

INotificacionRepository sage.ew.functions.Notifica.Repositorio = DependencyInjector.Instance.Retrieve<INotificacionRepository>()

getset

Instancia para gestionar el repositorio de datos.

Definición en la línea 634 del archivo Notifica.cs.

La documentación de esta clase está generada del siguiente archivo:

C:/actions-runner/_work/Sage.ES.Sage50/Sage.ES.Sage50/src/Sage.ES.S50/sage.ew.functions/Clases/Notifica.cs

Métodos públicos

Métodos públicos estáticos

Métodos protegidos

Propiedades

Descripción detallada

Documentación de funciones miembro

◆ _Add() [1/3]

◆ _Add() [2/3]

◆ _Add() [3/3]

◆ _Delete()

◆ _DeleteAll()

◆ _Get()

◆ _GetByCategoria()

◆ _Update()

◆ _UpdateAllVisto()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ ForceNotificaTimer()

◆ ShowMessage_Handler()

Documentación de propiedades

◆ _This

◆ Repositorio