Note samples
Aspectos básicos
Sección titulada «Aspectos básicos»Ejemplo de código sugerido
Sección titulada «Ejemplo de código sugerido»Primero debe crear el objeto webservice:
OKMWebservices ws = OKMWebservicesFactory.getInstance(host);A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:
ws.login(user, password);Llegados a este punto puede usar todos los métodos de Note desde la clase “note”, tal y como se muestra a continuación:
ws.note.add("373bcdd0-c082-4e7b-addd-e10ef813946e", "the note text");Métodos
Sección titulada «Métodos»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| add(String uuid, String text) | Note | Añade una nota a un nodo y devuelve un objeto Note. |
Ejemplo:
package com.openkm;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); ws.note.add("373bcdd0-c082-4e7b-addd-e10ef813946e", "the note text"); } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| get(String noteId) | Note | Recupera la nota. |
Ejemplo:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.Note;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); List<Note> notes = ws.note.list("373bcdd0-c082-4e7b-addd-e10ef813946e"); if (notes.size() > 0) { System.out.println(ws.get(notes.get(0).getPath())); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| delete(String noteId) | Note | Elimina una nota. |
Ejemplo:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.Note;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); List<Note> notes = ws.note.list("373bcdd0-c082-4e7b-addd-e10ef813946e"); if (notes.size() > 0) { ws.note.delete(notes.get(0).getPath()); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| set(String noteId, String text) | void | Cambia el texto de la nota. |
Ejemplo:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.Note;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); List<Note> notes = ws.note.list("373bcdd0-c082-4e7b-addd-e10ef813946e"); if (notes.size() > 0) { ws.note.set(notes.get(0).getPath(), "text modified"); } } catch (Exception e) { e.printStackTrace(); } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| list(String uuid) | List |
Recupera una lista con todas las notas de un nodo. |
Ejemplo:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.Note;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); List<Note> notes = ws.note.list("373bcdd0-c082-4e7b-addd-e10ef813946e"); for (Note note : notes) { System.out.println(note); } } catch (Exception e) { e.printStackTrace(); } }}getNoteHistories
Sección titulada «getNoteHistories»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getNoteHistories(String uuid) | List |
Devuelve el histórico de notas de un nodo. |
Ejemplo:
package com.openkm;
import java.util.List;
import com.openkm.sdk4j.OKMWebservices;import com.openkm.sdk4j.OKMWebservicesFactory;import com.openkm.sdk4j.bean.NoteHistory;
public class Test {
public static void main(String[] args) { String host = "http://localhost:8080/openkm"; String user = "okmAdmin"; String password = "admin"; OKMWebservices ws = OKMWebservicesFactory.getInstance(host);
try { ws.login(user, password); List<NoteHistory> list = ws.note.getNoteHistories("3c68b3a1-c65c-4b1e-84b5-9ce2712ca573"); for (NoteHistory noteHistory : list) { System.out.println(noteHistory); } } catch (Exception e) { e.printStackTrace(); } }}