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

SDK for .NET 1.5.0
Requirements
Sample client
Basic concepts
Auth samples
Bookmarck samples
Conversion samples
Dashboard samples
Document samples
Folder samples
Mail samples
Note samples
Notification samples
Property samples
PropertyGroup samples
Repository samples
Search samples
Workflow samples

Dashboard samples

Methods

getUserCheckedOutDocuments

Description:

MethodReturn valuesDescription

getUserCheckedOutDocuments()

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserCheckedOutDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastModifiedDocuments

Description:

MethodReturn valuesDescription

getUserLastModifiedDocuments()

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLastModifiedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLockedDocuments

Description:

MethodReturn valuesDescription

getUserLockedDocuments()

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLockedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSubscribedDocuments

Description:

MethodReturn valuesDescription

getUserSubscribedDocuments()

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserSubscribedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSubscribedFolders

Description:

MethodReturn valuesDescription

getUserSubscribedFolders()

List<DashboardFolderResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserSubscribedFolders();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastUploadedDocuments

Description:

MethodReturn valuesDescription

getUserLastUploadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents uploaded 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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLastUploadedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastDownloadedDocuments

Description:

MethodReturn valuesDescription

getUserLastDownloadedDocuments()

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLastDownloadedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastImportedMails

Description:

MethodReturn valuesDescription

getUserLastImportedMails()

List<DashboardMailResult>

Returns a list of the last mails 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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLastImportedMails();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserLastImportedMailAttachments

Description:

MethodReturn valuesDescription

getUserLastImportedMailAttachments()

List<DashboardDocumentResult>

Returns a list of the last mails 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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.getUserLastImportedMailAttachments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getUserSearchs

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;
using System.IO;

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

            try
            {
                List<QueryParams> queryParams = ws.getUserSearchs();
                foreach (QueryParams params in queryParams) 
                {
                   System.Console.WriteLine(params.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

findUserSearches

Description:

MethodReturn valuesDescription

findUserSearches(int qpId)

List<DashboardDocumentResult>

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;
using System.IO;

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

            try
            {
                List<DashboardDocumentResult> results = ws.findUserSearches(5);
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastWeekTopDownloadedDocuments

Description:

MethodReturn valuesDescription

getLastWeekTopDownloadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last week top documents downloaded.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastWeekTopDownloadedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastMonthTopDownloadedDocuments

Description:

MethodReturn valuesDescription

getLastMonthTopDownloadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last month top documents downloaded.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastMonthTopDownloadedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastWeekTopModifiedDocuments

Description:

MethodReturn valuesDescription

getLastWeekTopModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last week top documents modified.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastWeekTopModifiedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastMonthTopModifiedDocuments

Description:

MethodReturn valuesDescription

getLastMonthTopModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last month top documents modified.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastMonthTopModifiedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastModifiedDocuments

Description:

MethodReturn valuesDescription

getLastModifiedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents modified.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastModifiedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLastUploadedDocuments

Description:

MethodReturn valuesDescription

getLastUploadedDocuments()

List<DashboardDocumentResult>

Returns a list of the last documents uploaded.

Example:

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

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

            try
            {
                List<DashboardDocumentResult> results = ws.getLastUploadedDocuments();
                foreach (DashboardDocumentResult dashboardResult in results) 
                {
                   System.Console.WriteLine(dashboardResult.toString()); 
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

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