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 de carpeta válido.

Consejo

Ejemplo de fldId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”

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

Precaución

Una vez que ha iniciado sesión en el servicio web, la sesión se mantiene en el objeto del servicio web. A partir de ahí puede usar el resto de métodos de la API.

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

ws.folder.create("1be884f4-5758-4985-94d1-f18bfe004db8", "test");

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String fldId, String name)	Folder	Crea una nueva carpeta y devuelve 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);

            try
            {
                ws.login(user, password);
                ws.folder.create("f123a950-0329-4d62-8328-0ff500fd42db", "test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

create

Descripción:

Método	Valores de retorno	Descripción
create(String uuid, String name, long nodeClass)	Folder	Crea una nueva carpeta y devuelve 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);

            try
            {
                ws.login(user, password);
                long nodeClass = 0;
                ws.folder.create("f123a950-0329-4d62-8328-0ff500fd42db", "test", nodeClass);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createWithPropertyGroup

Descripción:

Método	Valores de retorno	Descripción
createWithPropertyGroup(String uuid, String name, long nodeClass, String grpName, Dictionary<String, String> properties)	Folder	Crea una nueva carpeta junto con un grupo de metadatos en una única llamada atómica, y devuelve un objeto Folder.

El valor de grpName debe ser un nombre de grupo de metadatos válido.

Nota

A diferencia de llamar primero a “create” y luego a “propertyGroup.addGroup”, este método crea la carpeta y asigna los valores del grupo de metadatos en una única llamada atómica.

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

            try
            {
                ws.login(user, password);
                long nodeClass = 0;
                Dictionary<String, String> props = new Dictionary<String, String>();
                props.Add("okp:consulting.name", "test");
                ws.folder.createWithPropertyGroup("f123a950-0329-4d62-8328-0ff500fd42db", "test", nodeClass, "okg:consulting", props);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getProperties

Descripción:

Método	Valores de retorno	Descripción
getProperties(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);

            try
            {
                ws.login(user, password);
                System.Console.WriteLine(ws.folder.getProperties("f123a950-0329-4d62-8328-0ff500fd42db").toString());
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

delete

Descripción:

Método	Valores de retorno	Descripción
delete(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);

            try
            {
                ws.login(user, password);
                ws.folder.delete("f123a950-0329-4d62-8328-0ff500fd42db");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

rename

Descripción:

Método	Valores de retorno	Descripción
rename(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);

            try
            {
                ws.login(user, password);
                // Exists folder /okm:root/test
                ws.folder.rename("f123a950-0329-4d62-8328-0ff500fd42db", "renamedFolder");
                // Folder has renamed to /okm:root/renamedFolder
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

move

Descripción:

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

El valor del parámetro dstId debe ser un UUID de carpeta o expediente, o una ruta.

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

            try
            {
                ws.login(user, password);
                // Exists folder /okm:root/test
                ws.folder.move("f123a950-0329-4d62-8328-0ff500fd42db", "ac165cab-a62a-4b17-89fc-2480a1d784db");
                // Folder has moved to /okm:root/tmp/test
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildren

Descripción:

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

El parámetro fldId puede ser un nodo de tipo carpeta o expediente.

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

            try
            {
                ws.login(user, password);
                foreach (Folder fld in ws.folder.getChildren("f123a950-0329-4d62-8328-0ff500fd42db"))
                {
                    System.Console.WriteLine(fld.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValid

Descripción:

Método	Valores de retorno	Descripción
isValid(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);

            try
            {
                ws.login(user, password);
                // Return true
                ws.folder.isValid("f123a950-0329-4d62-8328-0ff500fd42db");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPath

Descripción:

Método	Valores de retorno	Descripción
getPath(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);

            try
            {
                ws.login(user, password);
                System.Console.WriteLine(ws.folder.getPath("f123a950-0329-4d62-8328-0ff500fd42db"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copy

Descripción:

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

El valor del parámetro dstId debe ser un UUID de carpeta o expediente, o una ruta.

Cuando el valor del parámetro newName es null, la carpeta conservará el mismo nombre.

Precaución

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

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

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

            try
            {
                ws.login(user, password);
                ws.folder.copy("f123a950-0329-4d62-8328-0ff500fd42db", "a321a950-0329-4d62-8328-0ff500fd42db", "new_name");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String fldId, String dstId, String newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki, bool security)	Folder	Copia una carpeta junto con sus datos asociados en otra carpeta o expediente.

El valor del parámetro dstId debe ser un UUID de carpeta o expediente.

Cuando el valor del parámetro newName es null, la carpeta conservará el mismo nombre.

Nota

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

Además:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán 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 notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiará el valor original del wiki.
• Cuando el parámetro security es true, se copiará la configuración de seguridad original.

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

            try
            {
                ws.login(user, password);
                ws.folder.extendedCopy("f123a950-0329-4d62-8328-0ff500fd42db", "055e4384-7c70-4456-b32b-f5a55a79861f", "new_name", true, 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 recupera información sobre:

• El número de carpetas.
• El número de documentos.
• El número de expedientes.
• El número de correos.
• El tamaño en bytes de todos los objetos 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);

            try
            {
                 ws.login(user, password);
System.Console.WriteLine(ws.folder.getContentInfo(fldUUid).toString());
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purge

Descripción:

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

Normalmente, purgará las carpetas hacia /okm:trash/userId - la papelera personal del usuario - pero también es posible purgar directamente cualquier carpeta 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.

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

            try
            {
                ws.login(user, password);
                ws.folder.purge("f123a950-0329-4d62-8328-0ff500fd42db");
            } 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);

            try
            {
                ws.login(user, password);
                ws.folder.setStyle("f123a950-0329-4d62-8328-0ff500fd42db", 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 en la ruta.

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

            try
            {
               ws.login(user, password);
               ws.folder.createMissingFolders("/okm:root/missingfld1/missingfld2/missingfld3");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setDescription

Descripción:

Método	Valores de retorno	Descripción
setDescription(string fldId, String description)	void	Establece la descripción 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);

            try
            {
                ws.login(user, password);
                ws.folder.setDescription("f123a950-0329-4d62-8328-0ff500fd42db","Any description");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplate

Descripción:

Método	Valores de retorno	Descripción
createFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security Dictionary<String, String> properties)	Folder	Crea una nueva carpeta a partir de la plantilla y devuelve un objeto Folder.

El parámetro uuid es el fichero de la plantilla.

dstPath puede ser una ruta de carpeta o de expediente.

Cuando la plantilla usa grupos de metadatos para rellenar campos, estos valores son obligatorios y deben establecerse en el parámetro properties.

Nota

Para más información sobre plantillas y metadatos, consulte: Creating templates.

Nota

Además:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.

Ejemplo:

Nota

El siguiente ejemplo se basa en la muestra Creating PDF template.

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

               try
               {
                   ws.login(user, password);
                   Dictionary<String, String> properties = new Dictionary<String, String>();
                   properties.Add("okp:tpl.name", "Some name");
                   DateTime date = DateTime.Now;
                   // Value must be converted to String ISO 8601 compliant
                   properties.Add("okp:tpl.bird_date", ISO8601.formatBasic(date));
                   properties.Add("okp:tpl.language", "[ \"java\" ]");
                   Folder foder = ws.folder.createFromTemplate("9fa9787e-d8b0-4ff7-905a-a89f0b228ec8", "/okm:root/test/dst", true, true, false, true, true, properties));
               }
               catch (Exception e)
               {
                   System.Console.WriteLine(e.ToString());
               }
         }
    }
}