Ir al contenido

Dashboard samples

Básico

Sección titulada «Básico»

Ejemplo de código sugerido

Sección titulada «Ejemplo de código sugerido»

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto del servicio web “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Llegados a este punto puede usar todos los métodos de Dashboard desde la clase “dashboard”, tal y como se muestra a continuación:

ws.dashboard.getUserCheckedOutDocuments();

Métodos

Sección titulada «Métodos»

getUserCheckedOutDocuments

Sección titulada «getUserCheckedOutDocuments»

Descripción:

Método Valores de retorno Descripción
getUserCheckedOutDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los documentos que el usuario está editando.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserCheckedOutDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastModifiedDocuments

Sección titulada «getUserLastModifiedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastModifiedDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los documentos modificados más recientemente por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastModifiedDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLockedDocuments

Sección titulada «getUserLockedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLockedDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los documentos bloqueados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLockedDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLockedRecords

Sección titulada «getUserLockedRecords»

Descripción:

Método Valores de retorno Descripción
getUserLockedRecords(int offset, int limit) DashboardResultSet Devuelve una lista de los expedientes bloqueados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLockedRecords(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLockedFolders

Sección titulada «getUserLockedFolders»

Descripción:

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

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLockedFolders(0 ,5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLockedMails

Sección titulada «getUserLockedMails»

Descripción:

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

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLockedMails(0 ,5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserSubscribedDocuments

Sección titulada «getUserSubscribedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los documentos a los que está suscrito el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserSubscribedDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserSubscribedFolders

Sección titulada «getUserSubscribedFolders»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedFolders(int offset, int limit) DashboardResultSet Devuelve una lista de las carpetas a las que está suscrito el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserSubscribedFolders(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserSubscribedRecords

Sección titulada «getUserSubscribedRecords»

Descripción:

Método Valores de retorno Descripción
getUserSubscribedRecords(int offset, int limit) DashboardResultSet Devuelve una lista de los expedientes a los que está suscrito el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserSubscribedRecords(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastCreatedDocuments

Sección titulada «getUserLastCreatedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los últimos documentos creados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastCreatedDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastDocumentsNotesCreated

Sección titulada «getUserLastDocumentsNotesCreated»

Descripción:

Método Valores de retorno Descripción
getUserLastDocumentsNotesCreated(int offset, int limit) DashboardResultSet Devuelve una lista de las últimas notas de documentos creadas por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastDocumentsNotesCreated(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastCreatedFolders

Sección titulada «getUserLastCreatedFolders»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedFolders(int offset, int limit) DashboardResultSet Devuelve una lista de las últimas carpetas creadas por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastCreatedFolders(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastFoldersNotesCreated

Sección titulada «getUserLastFoldersNotesCreated»

Descripción:

Método Valores de retorno Descripción
getUserLastFoldersNotesCreated(int offset, int limit) DashboardResultSet Devuelve una lista de las últimas notas de carpetas creadas por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastFoldersNotesCreated(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastCreatedRecords

Sección titulada «getUserLastCreatedRecords»

Descripción:

Método Valores de retorno Descripción
getUserLastCreatedRecords(int offset, int limit) DashboardResultSet Devuelve una lista de los últimos expedientes creados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastCreatedRecords(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastRecordsNotesCreated

Sección titulada «getUserLastRecordsNotesCreated»

Descripción:

Método Valores de retorno Descripción
getUserLastRecordsNotesCreated(int offset, int limit) DashboardResultSet Devuelve una lista de las últimas notas de expedientes creadas por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastRecordsNotesCreated(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastDownloadedDocuments

Sección titulada «getUserLastDownloadedDocuments»

Descripción:

Método Valores de retorno Descripción
getUserLastDownloadedDocuments(int offset, int limit) DashboardResultSet Devuelve una lista de los últimos documentos descargados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastDownloadedDocuments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastImportedMails

Sección titulada «getUserLastImportedMails»

Descripción:

Método Valores de retorno Descripción
getUserLastImportedMails(int offset, int limit) DashboardResultSet Devuelve una lista de los últimos correos importados por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastImportedMails(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastMailsNotesCreated

Sección titulada «getUserLastMailsNotesCreated»

Descripción:

Método Valores de retorno Descripción
getUserLastMailsNotesCreated(int offset, int limit) DashboardResultSet Devuelve una lista de las últimas notas de correos creadas por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastMailsNotesCreated(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserLastImportedMailAttachments

Sección titulada «getUserLastImportedMailAttachments»

Descripción:

Método Valores de retorno Descripción
getUserLastImportedMailAttachments(int offset, int limit) DashboardResultSet Devuelve una lista de los últimos correos importados con adjuntos por el usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                DashboardResultSet resultSet = ws.dashboard.getUserLastImportedMailAttachments(0, 5);
                foreach (DashboardResult dashboardResult in resultSet.results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserSearches

Sección titulada «getUserSearches»

Descripción:

Método Valores de retorno Descripción
getUserSearches() List Devuelve una lista de las búsquedas guardadas por el usuario como novedades de usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                List<QueryParams> results = ws.dashboard.getUserSearches();
                foreach (QueryParams userSearch in results)
                {
                     System.Console.WriteLine(userSearch.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findUserSearches

Sección titulada «findUserSearches»

Descripción:

Método Valores de retorno Descripción
findUserSearches(long qpId) List Devuelve una lista de nodos a partir de una búsqueda guardada por el usuario (búsqueda de tipo novedades de usuario).

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                List<DashboardNodeResult> results = ws.dashboard.findUserSearches();
                foreach (DashboardNodeResult nodeResult in results)
                {
                     System.Console.WriteLine(nodeResult.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}