OKMNotification

Conceptos básicos

En la mayoría de los métodos verá un parámetro denominado “nodeId”. El valor de este parámetro puede ser el UUID de un documento, una carpeta, un correo o un expediente válidos.

Consejo

Ejemplo de nodeId:

• Usando uuid -> “b153c4b7-3d1c-4589-bd42-0ed0f34fd338”

Además, en todos los métodos verá un parámetro denominado “token”. Dado que las tareas Cron se ejecutan en segundo plano sin autenticación, los métodos utilizados en este escenario pueden emplear el parámetro token. Desde el contexto de ejecución predeterminado de la aplicación debe usar el valor “null”, que indica que la aplicación debe utilizar la “sesión de usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” mediante el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

subscribe

Descripción:

Método	Valores devueltos	Descripción
subscribe(String token, String nodeId)	void	Añade una suscripción a un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNotification okmNotification = ContextWrapper.getContext().getBean(OKMNotification.class);

            okmNotification.subscribe(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unsubscribe

Descripción:

Método	Valores devueltos	Descripción
unsubscribe(String token, String nodeId)	void	Elimina una suscripción a un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNotification okmNotification = ContextWrapper.getContext().getBean(OKMNotification.class);
            okmNotification.unsubscribe(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSubscriptors

Descripción:

Método	Valores devueltos	Descripción
getSubscriptors(String token, String nodeId)	Set	Recupera una lista de todos los suscriptores de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNotification okmNotification = ContextWrapper.getContext().getBean(OKMNotification.class);
            for (String subscriptor : okmNotification.getSubscriptors(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338")) {
                System.out.println(subscriptor);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

notify

Descripción:

Método	Valores devueltos	Descripción
notify(String token, String nodeId, List users, List mails, String message, boolean attachment)	void	Envía una notificación por correo electrónico.

Nota

El parámetro users es un conjunto de usuarios de OpenKM a los que se notificará.

El parámetro mails es un conjunto de direcciones de correo electrónico —normalmente correos externos— a las que se notificará.

El parámetro message es el contenido del cuerpo del correo electrónico.

Cuando el valor de attachment es true, el nodo se adjunta al correo electrónico.

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMNotification;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMNotification okmNotification = ContextWrapper.getContext().getBean(OKMNotification.class);
            List<String> users = new ArrayList<>();
            users.add("sochoa");
            List<String> mails = new ArrayList<>();
            String body = "Body of the message";
            okmNotification.notify(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", users, mails, body, false);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}