OKMNotification

Conceptos básicos

En casi todos los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID o una ruta válidos de documento, carpeta o correo.

Respecto al parámetro llamado “nodePath”, su valor puede ser una ruta válida de documento, carpeta o correo.

Además, en todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token, que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Métodos

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;

public class Test {
    public static void main(String[] args) {
        try {
            OKMNotification.getInstance().subscribe(null, "/okm:root/logo.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;

public class Test {
    public static void main(String[] args) {
        try {
            OKMNotification.getInstance().unsubscribe(null, "/okm:root/logo.png");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSubscriptors

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMNotification;

public class Test {
    public static void main(String[] args) {
        try {
            for (String subscriptor : OKMNotification.getInstance().getSubscriptors(null, "/okm:root/logo.png")) {
                System.out.println(subscriptor);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

notify

Descripción:

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

Ejemplo:

package com.openkm;

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

import com.openkm.api.OKMNotification;

public class Test {
    public static void main(String[] args) {
        try {
            List<String> users = new ArrayList<>();
            users.add("user1");
            List<String> mails = new ArrayList<>();
            String body = "Body of the message";
            OKMNotification.getInstance().notify(null, "/okm:root/logo.png", users, mails, body, false);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

proposedSubscription

Descripción:

Método	Valores de retorno	Descripción
proposedSubscription(String token, String nodeId, List users, String comment)	void	Propone una suscripción mediante una notificación por correo.

Ejemplo:

package com.openkm;

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

import com.openkm.api.OKMNotification;

public class Test {
    public static void main(String[] args) {
        try {
            List<String> users = new ArrayList<>();
            users.add("user1");
            String comment = "Body of the message";
            OKMNotification.getInstance().proposedSubscription(null, "/okm:root/logo.png", users, comment);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}