OKMNote
Conceptos básicos
Sección titulada «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, correo o registro.
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
Sección titulada «Métodos»addNote
Sección titulada «addNote»Descripción:
| Método | Valores devueltos | Descripción |
|---|---|---|
| add(String token, String nodeId, String text) | Note | Añade una nota a un nodo y devuelve un objeto Note. |
Ejemplo:
package com.openkm;
import com.openkm.api.OKMNote;import com.openkm.bean.Note;
public class Test { public static void main(String[] args) { try { Note note = OKMNote.getInstance().add(null, "/okm:root/logo.png", "the note text"); System.out.println(note); } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores devueltos | Descripción |
|---|---|---|
| get(String token, String noteId) | Note | Recupera la nota. |
Ejemplo:
package com.openkm;
import com.openkm.api.OKMNote;import com.openkm.bean.Note;
public class Test { public static void main(String[] args) { try { for (Note note : OKMNote.getInstance().list(null, "/okm:root/logo.png")) { Note data = OKMNote.getInstance().get(null, note.getPath()); System.out.println(data); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores devueltos | Descripción |
|---|---|---|
| delete(String token, String noteId) | void | Elimina una nota. |
Ejemplo:
package com.openkm;
import com.openkm.api.OKMNote;import com.openkm.bean.Note;
public class Test { public static void main(String[] args) { try { for (Note note : OKMNote.getInstance().list(null, "/okm:root/logo.png")) { OKMNote.getInstance().delete(null, note.getPath()); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores devueltos | Descripción |
|---|---|---|
| set(String token, String noteId, String text) | void | Cambia el texto de la nota. |
Ejemplo:
package com.openkm;
import com.openkm.api.OKMNote;import com.openkm.bean.Note;
public class Test { public static void main(String[] args) { try { for (Note note : OKMNote.getInstance().list(null, "/okm:root/logo.png")) { OKMNote.getInstance().set(null, note.getPath()); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores devueltos | Descripción |
|---|---|---|
| list(String token, String nodeId) | List |
Recupera una lista con todas las notas de un nodo. |
Ejemplo:
package com.openkm;
import com.openkm.api.OKMNote;import com.openkm.bean.Note;
public class Test { public static void main(String[] args) { try { for (Note note : OKMNote.getInstance().list(null, "/okm:root/logo.png")) { OKMNote.getInstance().set(null, note.getPath()); } } catch (Exception e) { e.printStackTrace(); } }}