GeneralUtils

GeneralUtils es un bean de Spring que proporciona métodos para enviar notificaciones de interfaz dentro de la aplicación a los usuarios.

Nota

GeneralUtils es un bean de Spring — accédase a él vía ContextWrapper.getContext().getBean(GeneralUtils.class) o inyéctelo con @Autowired.

Métodos

uiNotify (usuario actual)

Descripción:

Método	Valores devueltos	Descripción
uiNotify(String msg)	void	Envía una notificación de interfaz dentro de la aplicación al usuario actualmente autenticado.

• msg: El texto del mensaje de notificación.

Precaución

El usuario debe haber iniciado sesión antes de llamar a este método.

Ejemplo:

package com.openkm;

import com.openkm.util.ContextWrapper;
import com.openkm.util.GeneralUtils;

public class Test {

    public static void main(String[] args) {
        try {
            GeneralUtils generalUtils = ContextWrapper.getContext().getBean(GeneralUtils.class);
            generalUtils.uiNotify("Your export is ready.");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

uiNotify (conjunto de usuarios)

Descripción:

Método	Valores devueltos	Descripción
uiNotify(String msg, Set users)	void	Envía una notificación de interfaz dentro de la aplicación a un conjunto específico de usuarios.

• msg: El texto del mensaje de notificación.
• users: El conjunto de nombres de usuario a notificar.

Ejemplo:

package com.openkm;

import com.openkm.util.ContextWrapper;
import com.openkm.util.GeneralUtils;

import java.util.HashSet;
import java.util.Set;

public class Test {

    public static void main(String[] args) {
        try {
            GeneralUtils generalUtils = ContextWrapper.getContext().getBean(GeneralUtils.class);
            Set<String> recipients = new HashSet<>();
            recipients.add("jsmith");
            recipients.add("mjones");
            generalUtils.uiNotify("Scheduled maintenance in 10 minutes.", recipients);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

uiNotifyAll

Descripción:

Método	Valores devueltos	Descripción
uiNotifyAll(String msg)	void	Envía una notificación de interfaz dentro de la aplicación a todos los usuarios activos del tenant actual.

• msg: El texto del mensaje de notificación.

Ejemplo:

package com.openkm;

import com.openkm.util.ContextWrapper;
import com.openkm.util.GeneralUtils;

public class Test {

    public static void main(String[] args) {
        try {
            GeneralUtils generalUtils = ContextWrapper.getContext().getBean(GeneralUtils.class);
            generalUtils.uiNotifyAll("System will restart in 5 minutes. Please save your work.");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}