Folder samples

Aspectos básicos

En la mayoría de los métodos verá el parámetro llamado “fldId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de carpeta.

Consejo

Ejemplo de fldId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando path -> “/okm:root/test”

Métodos

createFolder

Descripción:

Método	Valores de retorno	Descripción
createFolder(Folder fld)	Folder	Crea una nueva carpeta y devuelve como resultado un objeto Folder.

Precaución

El resto de variables del objeto Folder (fld) no tendrán ningún efecto en la creación de la carpeta.

Le recomendamos usar el método siguiente, createFolderSimple, en lugar de este.

• La variable path del parámetro fld debe inicializarse. Indica la ruta de la carpeta dentro de OpenKM.

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                Folder fld = new Folder();
                fld.path ="/okm:root/test";
                ws.createFolder(fld);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFolderSimple

Descripción:

Método	Valores de retorno	Descripción
createFolderSimple(String fldPath)	Folder	Crea una nueva carpeta y devuelve como resultado un objeto Folder.

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                ws.createFolderSimple("/okm:root/test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getFolderProperties

Descripción:

Método	Valores de retorno	Descripción
getFolderProperties(String fldId)	Folder	Devuelve las propiedades de la carpeta.

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                System.Console.WriteLine(ws.getFolderProperties("/okm:root/test"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteFolder

Descripción:

Método	Valores de retorno	Descripción
deleteFolder(String fldId)	void	Elimina una carpeta.

Ejemplo:

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

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
            {
                ws.deleteFolder("/okm:root/test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

renameFolder

Descripción:

Método	Valores de retorno	Descripción
renameFolder(String fldId, String newName)	Folder	Renombra una carpeta.

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                // Exists folder /okm:root/test
                ws.renameFolder("/okm:root/test", "renamedFolder");
                // Folder has renamed to /okm:root/renamedFolder
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

moveFolder

Descripción:

Método	Valores de retorno	Descripción
moveFolder(String fldId, String dstId)	void	Mueve una carpeta a otra carpeta o expediente.

Ejemplo:

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

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
            {
                // Exists folder /okm:root/test
                ws.moveFolder("/okm:root/test", "/okm:root/tmp");
                // Folder has moved to /okm:root/tmp/test
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getFolderChildren

Descripción:

Método	Valores de retorno	Descripción
getFolderChildren(String fldId)	List	Devuelve una lista con todas las carpetas cuyo padre es fldId.

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                foreach (Folder fld in ws.getFolderChildren("/okm:root"))
                {
                    System.Console.WriteLine(fld);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValidFolder

Descripción:

Método	Valores de retorno	Descripción
isValidFolder(String fldId)	Boolean	Devuelve un booleano que indica si el nodo es una carpeta.

Ejemplo:

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

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
            {
                // Return false
                ws.isValidFolder("/okm:root/logo.png");
                // Return true
                ws.isValidFolder("/okm:root");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getFolderPath

Descripción:

Método	Valores de retorno	Descripción
getFolderPath(String uuid)	String	Convierte un UUID de carpeta en una ruta de carpeta.

Ejemplo:

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

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
            {
                System.Console.WriteLine(ws.getFolderPath("f123a950-0329-4d62-8328-0ff500fd42db"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copyFolder

Descripción:

Método	Valores de retorno	Descripción
copyFolder(String fldId, String dstId)	void	Copia una carpeta en otra carpeta o expediente.

Precaución

Solo se copian los permisos de seguridad al destino; los metadatos, palabras clave, etc. de la carpeta no se copian.

Vea el método “extendedFolderCopy” para esta funcionalidad.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.
• Cuando el valor del parámetro newName es null, la carpeta conservará el mismo nombre.

Ejemplo:

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

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
            {
                ws.copyFolder("/okm:root/test", "/okm:root/temp");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

extendedFolderCopy

Descripción:

Método	Valores de retorno	Descripción
extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)	void	Copia una carpeta junto con los datos asociados a otra carpeta o expediente.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. de la carpeta no se copian.

Adicionalmente:

• Cuando el parámetro category es true, se copian los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copian los valores originales de las palabras clave.
• Cuando el parámetro de grupos de metadatos es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro node es true, se copian los valores originales de las notas.
• Cuando el parámetro wiki es true, se copian los valores originales del wiki.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.

Ejemplo:

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

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
            {
                ws.extendedFolderCopy("/okm:root/test", "/okm:root/tmp", true, true, true, true, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getContentInfo

Descripción:

Método	Valores de retorno	Descripción
getContentInfo(String fldId)	ContentInfo	Devuelve un objeto ContentInfo con información sobre la carpeta.

• El objeto ContentInfo proporciona información sobre:

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:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                System.Console.WriteLine(ws.getContentInfo("/okm:root/test"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeFolder

Descripción:

Método	Valores de retorno	Descripción
purgeFolder(String fldId)	void	La carpeta se elimina permanentemente del repositorio.

Precaución

Cuando una carpeta se purga, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purgar elimina la carpeta de forma permanente del repositorio.

• Normalmente se purgan carpetas en /okm:trash/userId - las ubicaciones personales de la papelera de cada usuario - pero es posible purgar directamente cualquier carpeta de todo el repositorio.

Ejemplo:

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

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
            {
                ws.purgeFolder("/okm:trash/okmAdmin/test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setStyle

Descripción:

Método	Valores de retorno	Descripción
setStyle(String fldId, long styleId)	void	Establece el estilo de la carpeta.

Nota

Más información en Folder style.

Ejemplo:

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

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
            {
                ws.setStyle("/okm:trash/okmAdmin/test", 1);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createMissingFolders

Descripción:

Método	Valores de retorno	Descripción
createMissingFolders(String fldPath)	void	Crea las carpetas que falten.

Ejemplo:

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

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
            {
               ws.createMissingFolders("/okm:root/missingfld1/missingfld2/missingfld3");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}