Ir al contenido

OKMDashboard

Aspectos básicos

Sección titulada «Aspectos básicos»

En todos los métodos verá un parámetro llamado “token”. Como las tareas de Cron se ejecutan en segundo plano sin autenticación, los métodos usados en ese escenario pueden usar el parámetro token. Desde el contexto de ejecución por defecto de la aplicación, debe usar el valor “null”, que indica a la aplicación que debe usar la “sesión de usuario”.

Métodos

Sección titulada «Métodos»

getUserCheckedOutDocuments

Sección titulada «getUserCheckedOutDocuments»

Descripción:

Método Valores de retorno Descripción
getUserCheckedOutDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos con check-out realizado por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserCheckedOutDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastModifiedDocuments

Sección titulada «getUserLastModifiedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastModifiedDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos modificados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLastModifiedDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedDocuments

Sección titulada «getUserLockedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLockedDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos bloqueados por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLockedDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedRecords

Sección titulada «getUserLockedRecords»

Descripción:

Método Valores de retorno Descripción
getUserLockedRecords(String token, int offset, int limit) DashboardRecordResultSet Obtiene la lista de expedientes bloqueados por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;
import com.openkm.bean.DashboardRecordResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardRecordResultSet resultSet = okmDashboard.getUserLockedRecords(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardRecordResult dashboardRecordResult : resultSet.getResults()) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedFolders

Sección titulada «getUserLockedFolders»

Descripción:

Método Valores de retorno Descripción
getUserLockedFolders(String token, int offset, int limit) DashboardFolderResultSet Devuelve una lista de las carpetas bloqueadas por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;
import com.openkm.bean.DashboardFolderResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardFolderResultSet resultSet = okmDashboard.getUserLockedFolders(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardFolderResult dashboardFolderResult : resultSet.getResults()) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedMails

Sección titulada «getUserLockedMails»

Descripción:

Método Valores de retorno Descripción
getUserLockedMails(String token, int offset, int limit) DashboardMailResultSet Devuelve una lista de los correos bloqueados por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardMailResult;
import com.openkm.bean.DashboardMailResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardMailResultSet resultSet = okmDashboard.getUserLockedMails(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardMailResult dashboardMailResult : resultSet.getResults()) {
                System.out.println(dashboardMailResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedDocuments

Sección titulada «getUserSubscribedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos a los que está suscrito el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserSubscribedDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedFolders

Sección titulada «getUserSubscribedFolders»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedFolders(String token, int offset, int limit) DashboardFolderResultSet Obtiene la lista de carpetas a las que está suscrito el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;
import com.openkm.bean.DashboardFolderResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardFolderResultSet resultSet = okmDashboard.getUserSubscribedFolders(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardFolderResult dashboardFolderResult : resultSet.getResults()) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedRecords

Sección titulada «getUserSubscribedRecords»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedRecords(String token, int offset, int limit) DashboardRecordResultSet Obtiene la lista de expedientes a los que está suscrito el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;
import com.openkm.bean.DashboardRecordResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardRecordResultSet resultSet = okmDashboard.getUserSubscribedRecords(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardRecordResult dashboardRecordResult : resultSet.getResults()) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedDocuments

Sección titulada «getUserLastCreatedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos creados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLastCreatedDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedDocumentsNotes

Sección titulada «getUserLastCreatedDocumentsNotes»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedDocumentsNotes(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos/notas creados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLastCreatedDocumentsNotes(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedFolders

Sección titulada «getUserLastCreatedFolders»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedFolders(String token, int offset, int limit) DashboardFolderResultSet Obtiene la lista de carpetas creadas más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;
import com.openkm.bean.DashboardFolderResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardFolderResultSet resultSet = okmDashboard.getUserLastCreatedFolders(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardFolderResult dashboardFolderResult : resultSet.getResults()) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedFoldersNotes

Sección titulada «getUserLastCreatedFoldersNotes»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedFoldersNotes(String token, int offset, int limit) DashboardFolderResultSet Obtiene la lista de carpetas/notas creadas más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;
import com.openkm.bean.DashboardFolderResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardFolderResultSet resultSet = okmDashboard.getUserLastCreatedFoldersNotes(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardFolderResult dashboardFolderResult : resultSet.getResults()) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedRecords

Sección titulada «getUserLastCreatedRecords»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedRecords(String token, int offset, int limit) DashboardRecordResultSet Obtiene la lista de expedientes creados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;
import com.openkm.bean.DashboardRecordResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardRecordResultSet resultSet = okmDashboard.getUserLastCreatedRecords(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardRecordResult dashboardRecordResult : resultSet.getResults()) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedRecordsNotes

Sección titulada «getUserLastCreatedRecordsNotes»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedRecordsNotes(String token, int offset, int limit) DashboardRecordResultSet Obtiene la lista de expedientes/notas creados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;
import com.openkm.bean.DashboardRecordResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardRecordResultSet resultSet = okmDashboard.getUserLastCreatedRecordsNotes(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardRecordResult dashboardRecordResult : resultSet.getResults()) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastDownloadedDocuments

Sección titulada «getUserLastDownloadedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastDownloadedDocuments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de documentos descargados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLastDownloadedDocuments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMails

Sección titulada «getUserLastImportedMails»

Descripción:

Método Valores de retorno Descripción
getUserLastImportedMails(String token, int offset, int limit) DashboardMailResultSet Obtiene la lista de correos importados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardMailResult;
import com.openkm.bean.DashboardMailResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardMailResultSet resultSet = okmDashboard.getUserLastImportedMails(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardMailResult dashboardMailResult : resultSet.getResults()) {
                System.out.println(dashboardMailResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedMailsNotes

Sección titulada «getUserLastCreatedMailsNotes»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedMailsNotes(String token, int offset, int limit) DashboardMailResultSet Obtiene la lista de correos/notas importados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardMailResult;
import com.openkm.bean.DashboardMailResultSet;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardMailResultSet resultSet = okmDashboard.getUserLastCreatedMailsNotes(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardMailResult dashboardMailResult : resultSet.getResults()) {
                System.out.println(dashboardMailResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMailAttachments

Sección titulada «getUserLastImportedMailAttachments»

Descripción:

Método Valores de retorno Descripción
getUserLastImportedMailAttachments(String token, int offset, int limit) DashboardDocumentResultSet Obtiene la lista de adjuntos de correo importados más recientemente por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;
import com.openkm.ws.rest.util.DashboardDocumentResultSet;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            DashboardDocumentResultSet resultSet = okmDashboard.getUserLastImportedMailAttachments(null, 0, 5);
            System.out.println("Total: " + resultSet.getTotal());
            for (DashboardDocumentResult dashboardDocumentResult : resultSet.getResults()) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserDocumentsSize

Sección titulada «getUserDocumentsSize»

Descripción:

Método Valores de retorno Descripción
getUserDocumentsSize(String token) long Devuelve el tamaño total en bytes de los documentos del usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.util.ContextWrapper;
import com.openkm.util.FormatUtil;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            long sizeInBytes = okmDashboard.getUserDocumentsSize(null);
            System.out.println(FormatUtil.formatSize(sizeInBytes));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSearches

Sección titulada «getUserSearches»

Descripción:

Método Valores de retorno Descripción
getUserSearches(String token) List Obtiene la lista de todas las “novedades de usuario” guardadas por el usuario.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.db.bean.QueryParams;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (QueryParams qp : okmDashboard.getUserSearches(null)) {
                System.out.println(qp);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Sección titulada «find»

Descripción:

Método Valores de retorno Descripción
find(String token, int qpId) List Ejecuta una búsqueda de “novedades de usuario”.
  • El parámetro qpId es el identificador único de la búsqueda de “novedades de usuario”.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardNodeResult;
import com.openkm.bean.Document;
import com.openkm.bean.Folder;
import com.openkm.bean.Mail;
import com.openkm.bean.Record;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            int qpId = 12;
            for (DashboardNodeResult dashboardNodeResult : okmDashboard.find(null, qpId)) {
                if (dashboardNodeResult.getNode() instanceof Document) {
                    Document doc = (Document) dashboardNodeResult.getNode();
                    System.out.println(doc);
                } else if (dashboardNodeResult.getNode() instanceof Folder) {
                    Folder fld = (Folder) dashboardNodeResult.getNode();
                    System.out.println(fld);
                } else if (dashboardNodeResult.getNode() instanceof Record) {
                    Record rec = (Record) dashboardNodeResult.getNode();
                    System.out.println(rec);
                } else if (dashboardNodeResult.getNode() instanceof Mail) {
                    Mail mail = (Mail) dashboardNodeResult.getNode();
                    System.out.println(mail);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopDownloadedDocuments

Sección titulada «getLastWeekTopDownloadedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastWeekTopDownloadedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos más descargados durante la última semana por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastWeekTopDownloadedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopDownloadedDocuments

Sección titulada «getLastMonthTopDownloadedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastMonthTopDownloadedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos más descargados durante el último mes por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastMonthTopDownloadedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopModifiedDocuments

Sección titulada «getLastWeekTopModifiedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastWeekTopModifiedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos más modificados durante la última semana por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastWeekTopModifiedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopModifiedDocuments

Sección titulada «getLastMonthTopModifiedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastMonthTopModifiedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos más modificados durante el último mes por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastMonthTopModifiedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastModifiedDocuments

Sección titulada «getLastModifiedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastModifiedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos modificados más recientemente por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastModifiedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedDocuments

Sección titulada «getLastCreatedDocuments»

Descripción:

Método Valores de retorno Descripción
getLastCreatedDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos creados más recientemente por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastCreatedDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCheckedOutDocuments

Sección titulada «getLastCheckedOutDocuments»

Descripción:

Método Valores de retorno Descripción
getLastCheckedOutDocuments(String token, int offset, int limit) List Obtiene la lista de los documentos con check-out realizado más recientemente por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardDocumentResult dashboardDocumentResult : okmDashboard.getLastCheckedOutDocuments(null, 0, 5)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedFolders

Sección titulada «getLastCreatedFolders»

Descripción:

Método Valores de retorno Descripción
getLastCreatedFolders(String token, int offset, int limit) List Obtiene la lista de las carpetas creadas más recientemente por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardFolderResult dashboardFolderResult : okmDashboard.getLastCreatedFolders(null, 0, 5)) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedRecords

Sección titulada «getLastCreatedRecords»

Descripción:

Método Valores de retorno Descripción
getLastCreatedRecords(String token, int offset, int limit) List Obtiene la lista de los expedientes creados más recientemente por todos los usuarios.

Ejemplo:

package com.openkm;


import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;
import com.openkm.util.ContextWrapper;


public class Test {


    public static void main(String[] args) {
        try {
            OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
            for (DashboardRecordResult dashboardRecordResult : okmDashboard.getLastCreatedRecords(null, 0, 5)) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

visitNode

Sección titulada «visitNode»

Descripción:

Método Valores de retorno Descripción
visitNode(String token, String source, String node, Calendar date) void Marca un nodo como visitado.
  • Fuentes disponibles:

Ejemplo:

package com.openkm;


import java.util.Calendar;


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


public class Test {


  public static void main(String[] args) {
    try {
      OKMDashboard okmDashboard = ContextWrapper.getContext().getBean(OKMDashboard.class);
      Calendar cal = Calendar.getInstance();
      okmDashboard.visitNode(null, "LastWeekTopDownloadedDocuments", "/okm:root/document.pdf", cal);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}