Stamp samples

Aspectos básicos

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 webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los webservices, la sesión se mantiene en el objeto webservice. 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 Stamp desde la “clase stamp”, tal y como se muestra a continuación:

ws.stamp.getAllStamps();

Métodos

getAllStamps

Descripción:

Método	Valores de retorno	Descripción
getAllStamps()	List	Devuelve una lista de elementos de sello (stamp).

Ejemplo:

using System; using System.Collections.Generic;
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);
                List<StampItem> stamps = ws.stamp.getAllStamps();
                foreach(StampItem stamItem in stamps)
                {
                     System.Console.WriteLine(stamItem.name);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

testGetStampTextByPk

Descripción:

Método	Valores de retorno	Descripción
getStampTextByPk(long id, String uuid)	StampText	Devuelve el sello de tipo Text por ID.

Ejemplo:

using System; using System.Collections.Generic;
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 id = 1;
                List<StampItem> stamps = ws.stamp.getStampTextByPk(id, document.uuid);
                System.Console.WriteLine(stamp.name);
                System.Console.WriteLine(stamp.description);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

getStampImageByPk

Descripción:

Método	Valores de retorno	Descripción
getStampImageByPk(long id, String uuid)	StampImage	Devuelve el sello de tipo Image por ID.

Ejemplo:

using System;
using System.Collections.Generic;
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 id = 1;
                List<StampItem> stamps = ws.stamp.getStampImageByPk(id, document.uuid);
                System.Console.WriteLine(stampImage.name);
                System.Console.WriteLine(stampImage.description);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

getStampBarcodeByPk

Descripción:

Método	Valores de retorno	Descripción
getStampBarcodeByPk(long id, String uuid)	StampBarcode	Devuelve el sello de tipo Barcode por ID.

Ejemplo:

using System;
using System.Collections.Generic;
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 id = 1;
                StampBarcode stampBarcode = ws.stamp.getStampBarcodeByPk(id, "6330d2a0-529f-4c14-baa1-ce6a92004e01");
                System.Console.WriteLine(stampBarcode.name);
                System.Console.WriteLine(stampBarcode.description);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

calculateStampCoordinates

Descripción:

Método	Valores de retorno	Descripción
calculateStampCoordinates(long imgToStampWidth, long imgToStampHeight, long floatingDivWidth, long floatingDivHeight, String exprX, String exprY, String stampType, String stampAlign)	StampCoordinates	Devuelve las coordenadas calculadas del sello.

Nota

En los campos Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Para centrar un sello en la página, puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

El parámetro stampAlign.

Nota

Valores disponibles:

• text
• image

El parámetro stampAlign es la alineación del texto.

Nota

Valores disponibles:

• left
• center
• right

Ejemplo:

using System; using System.Collections.Generic;
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);
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long floatingDivWidth = 250;
                long floatingDivHeight = 300;
                string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
                string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
                string stampType = "text";
                string stampAlign = "center";
                StampCoordinates stampCoordinates = ws.stamp.calculateStampCoordinates(imgToStampWidth, imgToStampHeight,
                floatingDivWidth, floatingDivHeight, exprX, exprY, stampType, stampAlign);
                System.Console.WriteLine("X = " + stampCoordinates.x + ", Y = " + stampCoordinates.y);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

calculateStampExpressions

Descripción:

Método	Valores de retorno	Descripción
calculateStampExpressions(long imgToStampWidth, long imgToStampHeight, long posX, long posY)	StampExpressions	Devuelve las expresiones de sello calculadas para X e Y.

Ejemplo:

using System; using System.Collections.Generic;
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);
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long posX = 10;
                long posY = 50;
                StampExpressions stampExpressions = ws.stamp.calculateStampExpressions(imgToStampWidth, imgToStampHeight, posX, posY);
                System.Console.WriteLine("X = " + stampExpressions.exprX + ", Y = " + stampExpressions.exprY);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampText

Descripción:

Método	Valores de retorno	Descripción
stampText(String uuid, long id)	void	Estampa texto en un documento.

Ejemplo:

using System; using System.Collections.Generic;
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 id = "1";
                ws.stamp.stampText("babe24df-c443-49a5-9453-39dfc9b27924", id);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampImage

Descripción:

Método	Valores de retorno	Descripción
stampImage(String uuid, long id)	void	Estampa una imagen en un documento.

Ejemplo:

using System; using System.Collections.Generic;
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 id = "3";
                ws.stamp.stampImage("babe24df-c443-49a5-9453-39dfc9b27924", id);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampBarcode

Descripción:

Método	Valores de retorno	Descripción
stampBarcode(String uuid, long id)	void	Estampa un código de barras en un documento.

Ejemplo:

using System; using System.Collections.Generic;
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 id = 1;
                ws.stamp.stampBarcode("6330d2a0-529f-4c14-baa1-ce6a92004e01", id);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampImageManually

Descripción:

Método	Valores de retorno	Descripción
stampImageCustom(String uuid, long id, String exprX, String exprY, String range, String personalStampUuid)	void	Estampa un documento con una imagen personalizada.

Nota

id es el ID de un sello de tipo imagen creado por el administrador.

exprX es la expresión que establece la posición en la coordenada X.

exprY es la expresión que establece la posición en la coordenada Y.

personalStampUuid debe ser un UUID de documento válido. El documento debe ser una imagen (jpg o png).

Nota

En los campos Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página, puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

Ejemplo:

using System; using System.Collections.Generic;
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 stampId = "1";
                string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
                string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
                ws.stamp.stampImageCustom("babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "", "928de61e-6ceb-4f94-bf20-9ba2405c5cee");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampTextCustom

Descripción:

Método	Valores de retorno	Descripción
stampTextCustom(String uuid, long id, String text, String exprX, String exprY, String range)	void	Estampa un documento con un texto personalizado.

Nota

id es el ID de un sello de tipo texto creado por el administrador.

exprX es la expresión que establece la posición en la coordenada X.

exprY es la expresión que establece la posición en la coordenada Y.

Nota

En los campos Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página, puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

Ejemplo:

using System; using System.Collections.Generic;
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 stampId = "1";
                string text = "Any text";
                string exprX = "PAGE_CENTER";
                string exprY = "PAGE_MIDDLE";
                ws.stamp.stampTextCustom("babe24df-c443-49a5-9453-39dfc9b27924", stampId, text, exprX, exprY, "");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

stampImageCustom

Descripción:

Método	Valores de retorno	Descripción
stampImageCustom(String uuid, long id, String exprX, String exprY, String range, double ratio, FileStream fs)	void	Estampa un documento con una imagen personalizada.

Nota

id es el ID de un sello de tipo imagen creado por el administrador.

exprX es la expresión que establece la posición en la coordenada X.

exprY es la expresión que establece la posición en la coordenada Y.

Nota

En los campos Expr. X y Expr. Y puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página, puede usar:

Expr. X	PAGE_CENTER
Expr. Y	PAGE_MIDDLE
:::

Ejemplo:

using System; using System.Collections.Generic;
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 stampId = "1";
              string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
              string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
              FileStream fsimg = new FileStream(@"C:\test.jpg", FileMode.Open, FileAccess.Read);
              ws.stamp.stampImageCustom("babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "", 0, fsimg);
              fsimg.Close();
          }
          catch (Exception e)
          {
              System.Console.WriteLine(e.ToString());
          }
       }
    }
}

calculateFlyImageDimensions

Descripción:

Método	Valores de retorno	Descripción
calculateFlyImageDimensions(String uuid, long imgToStampWidth, long imgToStampHeight, long floatingImageWidth, long floatingImageHeight, int pageNumber)	StampImageSize	Devuelve el alto y ancho calculados de la imagen a estampar.

Ejemplo:

using System; using System.Collections.Generic;
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);
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long floatingImageWidth = 300;
                long floatingImageHeight = 300;
                int pageNumber = 2;

                StampImageSize stampImageSize = ws.stamp.calculateFlyImageDimensions("babe24df-c443-49a5-9453-39dfc9b27924", imgToStampWidth, imgToStampHeight,
                       floatingImageWidth, floatingImageHeight, pageNumber);
                System.Console.WriteLine(stampImageSize);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

getPersonalStamps

Descripción:

Método	Valores de retorno	Descripción
getPersonalStamps()	List	Devuelve una lista de sellos personales.

Nota

Devuelve una lista de documentos de tipo imagen (jpg o png) de /okm:templates/userId/stamps.

Ejemplo:

using System; using System.Collections.Generic;
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);
                List<Document> docs = ws.stamp.getPersonalStamps();
                foreach (Document doc in docs)
                {
                     System.Console.WriteLine(doc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

getPersonalStampImage

Descripción:

Método	Valores de retorno	Descripción
getPersonalStampImage(String uuid, long id)	StampPersonalImage	Devuelve el sello personal procesado.

Nota

Al estampar un documento con una imagen, la imagen también puede tener una capa de texto.

Este método procesa la imagen y devuelve una imagen con la capa de texto.

uuid debe ser un UUID devuelto por el método getPersonalStamps.

Ejemplo:

using System; using System.Collections.Generic;
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 stampId = 1;
                StampPersonalImage stampPersonalImage = ws.stamp.getPersonalStampImage("928de61e-6ceb-4f94-bf20-9ba2405c5cee", stampId);
                System.Console.WriteLine(stampPersonalImage.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}