1. Home
  2. SDK for .NET 3.6.0
  3. Dashboard samples
  1.  

SDK for .NET 3.6.0
Requirements
Sample client
Basic concepts
Activity samples
Auth samples
Bookmark samples
Conversion samples
Dashboard samples
Document samples
Folder samples
Mail samples
Node samples
Note samples
Notification samples
Plugin samples
Property samples
PropertyGroup samples
Record samples
Relation samples
Repository samples
Report samples
Search samples
Task samples
Workflow samples

Dashboard samples

 Methods

getUserCheckedOutDocuments

Description:

MethodReturn valuesDescription

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

getUserLastModifiedDocuments

Description:

MethodReturn valuesDescription

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

getUserLockedDocuments

Description:

MethodReturn valuesDescription

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

getUserLockedRecords

Description:

MethodReturn valuesDescription

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

getUserSubscribedDocuments

Description:

MethodReturn valuesDescription

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

getUserSubscribedFolders

Description:

MethodReturn valuesDescription

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

getUserSubscribedRecords

Description:

MethodReturn valuesDescription

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

getUserLastCreatedDocuments

Description:

MethodReturn valuesDescription

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

getUserLastCreatedFolders

Description:

MethodReturn valuesDescription

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

getUserLastCreatedRecords

Description:

MethodReturn valuesDescription

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

getUserLastDownloadedDocuments

Description:

MethodReturn valuesDescription

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

getUserLastImportedMails

Description:

MethodReturn valuesDescription

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

getUserLastImportedMailAttachments

Description:

MethodReturn valuesDescription

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

getUserSearches

Description:

MethodReturn valuesDescription

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.getUserSearches();
                foreach (QueryParams userSearch in results)
                {
                     System.Console.WriteLine(userSearch.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

findUserSearches

Description:

MethodReturn valuesDescription

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.findUserSearches();
                foreach (DashboardNodeResult nodeResult in results)
                {
                     System.Console.WriteLine(nodeResult.toString());
                }
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

© OpenKM kcenter v.1.0.0 (build: d51a7b0). All Rights Reserved. Documentation license