Dashboard samples

Basic

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then should login using the method "login". You can access the "login" method from webservice object "ws" as is shown below:

ws.login(user, password);

Once you are logged with the webservices the session is keep in the webservice Object. Then you can use the other API method

At this point you can use all the Dashboard methods from "dasboard" class as is shown below:

ws.dashboard.getUserCheckedOutDocuments();

Methods

getUserCheckedOutDocuments

Description:

Method	Return values	Description
getUserCheckedOutDocuments()	List<DashboardResult>	Returns a list of the documents in edition by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserCheckedOutDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastModifiedDocuments

Description:

Method	Return values	Description
getUserLastModifiedDocuments()	List<DashboardResult>	Returns a list of the last documents modified by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastModifiedDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLockedDocuments

Description:

Method	Return values	Description
getUserLockedDocuments()	List<DashboardResult>	Returns a list of the documents locked by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLockedDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLockedRecords

Description:

Method	Return values	Description
getUserLockedRecords()	List<DashboardResult>	Returns a list of the records locked by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLockedRecords();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSubscribedDocuments

Description:

Method	Return values	Description
getUserSubscribedDocuments()	List<DashboardResult>	Returns a list of the documents subscribed by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserSubscribedDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSubscribedFolders

Description:

Method	Return values	Description
getUserSubscribedFolders()	List<DashboardResult>	Returns a list of the folders subscribed by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserSubscribedFolders();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSubscribedRecords

Description:

Method	Return values	Description
getUserSubscribedRecords()	List<DashboardResult>	Returns a list of the records subscribed by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserSubscribedRecords();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastCreatedDocuments

Description:

Method	Return values	Description
getUserLastCreatedDocuments()	List<DashboardResult>	Returns a list of the last documents created by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastCreatedDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastCreatedFolders

Description:

Method	Return values	Description
getUserLastCreatedFolders()	List<DashboardResult>	Returns a list of the last folders created by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastCreatedFolders();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastCreatedRecords

Description:

Method	Return values	Description
getUserLastCreatedRecords()	List<DashboardResult>	Returns a list of the last records created by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastCreatedRecords();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastDownloadedDocuments

Description:

Method	Return values	Description
getUserLastDownloadedDocuments()	List<DashboardResult>	Returns a list of the last documents downloaded by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastDownloadedDocuments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastImportedMails

Description:

Method	Return values	Description
getUserLastImportedMails()	List<DashboardResult>	Returns a list of the last emails imported by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastImportedMails();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastImportedMailAttachments

Description:

Method	Return values	Description
getUserLastImportedMailAttachments()	List<DashboardResult>	Returns a list of the last emails imported with attachments by the user.

Example:

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<DashboardResult> results = ws.dashboard.getUserLastImportedMailAttachments();
                foreach (DashboardResult dashboardResult in results)
                {
                     System.Console.WriteLine(dashboardResult.node.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSearches

Description:

Method	Return values	Description
getUserSearches()	List<QueryParams>	Returns a list of the searches saved by the user as user news.

Example:

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

Description:

Method	Return values	Description
findUserSearches(long qpId)	List<DashboardNodeResult>	Returns a list of nodes based in a search saved by the user ( search of type user news ).

Example:

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());
            } 
        }
    }
}

Table of contents [ Hide Show ]

Basic
Methods

getUserCheckedOutDocuments
getUserLastModifiedDocuments
getUserLockedDocuments
getUserLockedRecords
getUserSubscribedDocuments
getUserSubscribedFolders
getUserSubscribedRecords
getUserLastCreatedDocuments
getUserLastCreatedFolders
getUserLastCreatedRecords
getUserLastDownloadedDocuments
getUserLastImportedMails
getUserLastImportedMailAttachments
getUserSearches
findUserSearches

SDK for .NET 3.9.0

Dashboard samples

Basic

Suggested code sample

Methods

getUserCheckedOutDocuments

getUserLastModifiedDocuments

getUserLockedDocuments

getUserLockedRecords

getUserSubscribedDocuments

getUserSubscribedFolders

getUserSubscribedRecords

getUserLastCreatedDocuments

getUserLastCreatedFolders

getUserLastCreatedRecords

getUserLastDownloadedDocuments

getUserLastImportedMails

getUserLastImportedMailAttachments

getUserSearches

findUserSearches