Descripción

Esta clase maneja toda la comunicación con los servicios web de captura de pantalla de GrabzIt.

Métodos públicos

• GrabzItFile GetResult(String id)
• URLToAnimation(String url, AnimationOptions options)
• URLToImage(String url, ImageOptions options)
• HTMLToImage(String html, ImageOptions options)
• FileToImage(String path, ImageOptions options)
• URLToPDF(String url, PDFOptions options)
• HTMLToPDF(String html, PDFOptions options)
• FileToPDF(String path, PDFOptions options)
• URLToDOCX(String url, DOCXOptions options)
• HTMLToDOCX(String html, DOCXOptions options)
• FileToDOCX(String path, DOCXOptions options)
• URLToTable(String url, TableOptions options)
• HTMLToTable(String html, TableOptions options)
• FileToTable(String path, TableOptions options)
• URLToRenderedHTML(String url, HTMLOptions options)
• HTMLToRenderedHTML(String html, HTMLOptions options)
• FileToRenderedHTML(String path, HTMLOptions options)
• String Save()
• String Save(String callBackURL)
• GrabzItFile SaveTo()
• boolean SaveTo(String saveToFile)
• Status GetStatus(String id)
• GrabzItCookie[] GetCookies(String domain)
• boolean SetCookie(String name, String domain, String value, String path, boolean httponly, Date? expires)
• boolean DeleteCookie(String name, String domain)
• WaterMark[] GetWaterMarks()
• WaterMark GetWaterMark(String identifier)
• boolean AddWaterMark(String identifier, String path, HorizontalPosition xpos, VerticalPosition ypos)
• boolean DeleteWaterMark(String identifier)
• SetLocalProxy(String proxyUrl)
• UseSSL(boolean value)
• String CreateEncryptionKey()
• Decrypt(String path, String key)
• GrabzItFile Decrypt(GrabzItFile file, String key)
• byte[] Decrypt(byte[] data, String key)

GrabzItFile GetResult(String carné de identidad)

Este método devuelve la captura de pantalla en sí. Si no se devuelve nada, entonces algo salió mal o la captura de pantalla aún no está lista.

parámetros

• id: el identificador único de la captura de pantalla
  • Requerido

Valor de retorno

GrabzItFile objeto

---

URLToAnimation(String url AnimationOptions opciones)

Especifique la URL del video en línea que debe convertirse into un GIF animado.

parámetros

• url: la URL del video en línea para convertir into un GIF animado.
  • Requerido
  • Acepta URL de videos de Vimeo y YouTube
    • La advertencia de animación de videos de Vimeo y YouTube depende de un tercero y, por lo tanto, puede no proporcionar resultados consistentes.
• opciones - una instancia de la AnimationOptions clase que define cualquier opción especial para usar al crear el GIF animado.

Valor de retorno

vacío

AnimationOptions

La clase representa todas las opciones disponibles al crear un GIF animado.

Propiedades publicas

• setCustomId(String value) - Identificador personalizado que puede pasar al servicio web animado GIF. Esto se devolverá con la URL de devolución de llamada que ha especificado.
  • Predeterminado: vacío
• setWidth(int value) - el ancho del GIF animado resultante en píxeles.
  • Predeterminado: 180px
  • Máximo: ancho máximo para el paquete
  • Tamaño automático: -1 (pasando -1 significa que el ancho de la GIF animado se escala en relación con su altura, si el ancho se ajusta automáticamente, la altura no puede)
• setHeight(int value) - la altura del GIF animado resultante en píxeles.
  • Predeterminado: 120px
  • Máximo: altura máxima para el paquete
  • Tamaño automático: -1 (pasando -1 significa que la altura de la GIF animado se escala en relación con su ancho, si la altura se está dimensionando automáticamente, el ancho no puede)
• setStart(int value) - la posición inicial del video que debe convertirse into un GIF animado.
  • Predeterminado: 0 segundos
• setDuration(int value) - la duración en segundos del video que debe convertirse into un GIF animado.
  • Valor predeterminado: longitud máxima para el paquete
• setSpeed(float value) - La velocidad del GIF animado.
  • Predeterminado: 1
  • Mínimo: 0.2
  • Máxima: 10
• setFramesPerSecond(float value) - la cantidad de fotogramas por segundo que deben capturarse del video.
  • Predeterminado: 10
  • Mínimo: 0.2
  • Máxima: 60
• setRepeat(int value) - Número de veces para recorrer el GIF animado.
  • Predeterminado: 0
  • Bucle continuo: 0
  • Nunca bucle: -1
• setReverse(boolean value) - si es cierto, los cuadros del GIF animado se invierten
  • Predeterminado: falso
• setCustomWaterMarkId(String value) - Agrega un personalizado watermark or especial watermark al GIF animado
  • Predeterminado: vacío
• setQuality(int value) - el calidad de la imagen devuelta, que tiene una compresión predeterminada de 85%.
  • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
  • Predeterminado: -1
  • Mínimo: -1
  • Máxima: 100
• setCountry(Country value) - el país el GIF animado debe tomarse de.
  • Valor predeterminado: la ubicación más rápida actual
  • Opciones: País.SINGAPUR, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío

---

URLToImage(String url ImageOptions opciones)

Especifica la URL que se debe convertir into una captura de pantalla de imagen.

parámetros

• url: la URL de la que debe estar hecha la captura de pantalla
  • Requerido
• opciones - una instancia de la ImageOptions clase que define cualquier opción especial para usar al crear la captura de pantalla.

Valor de retorno

vacío

HTMLToImage(String html, ImageOptions opciones)

Especifica el HTML que se debe convertir intuna imagen

parámetros

• html - el HTML para convertir intuna imagen
  • Requerido
• opciones - una instancia de la ImageOptions clase que define cualquier opción especial para usar al crear una imagen.

Valor de retorno

vacío

FileToImage(String camino, ImageOptions opciones)

Especifica un archivo HTML que debe convertirse intuna imagen

parámetros

• ruta de acceso: la ruta del archivo HTML para convertir intuna imagen
  • Requerido
• opciones - una instancia de la ImageOptions clase que define cualquier opción especial para usar al crear una imagen.

Valor de retorno

vacío

ImageOptions

La clase representa todas las opciones disponibles al crear capturas de imágenes.

Propiedades publicas

• setCustomId(String value) - Identificador personalizado que puede pasar al servicio web de captura de pantalla. Esto se devolverá con la URL de devolución de llamada que ha especificado.
  • Predeterminado: vacío
• setBrowserWidth(int value) - el ancho del navegador en píxeles
  • Predeterminado: 1366
  • Máxima: 10000
• setBrowserHeight(int value) - la altura del navegador en píxeles
  • Predeterminado: 1170
  • Máxima: 10000
  • Longitud total: -1 (pasar -1 significa que se toma una captura de pantalla de toda la página web)
• setOutputWidth(int value) - el ancho de la miniatura resultante en píxeles
  • Predeterminado: si no se especifican el ancho y la altura de salida o 0, el ancho y la altura de salida coincidirán con el ancho y alto de la imagen final, si se especifica la altura de salida, el ancho de salida será proporcional a la altura de salida
  • Máximo: ancho máximo para el paquete
  • Ancho completo: -1 (pasar -1 significa que el ancho de la miniatura no se reduce)
• setOutputHeight(int value) - la altura de la miniatura resultante en píxeles
  • Predeterminado: si no se especifica el ancho y la altura de salida o 0, entonces el ancho y alto de salida coincidirán con el ancho y alto de la imagen final, si se especifica el ancho de salida, la altura de salida será proporcional al ancho de salida
  • Máximo: altura máxima para el paquete
  • Altura completa: -1 (pasar -1 significa que la altura de la miniatura no se reduce)
• setFormat(ImageFormat value) - el formato en el que debe estar la captura de pantalla.
  • Por defecto: ImageFormat. JPG
  • Opciones: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormat.BMP, ImageFormat.PELEA, ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - el número de milisegundos a espera antes de tomar la captura de pantalla
  • Predeterminado: 0
  • Máxima: 30000
• setClickElement - esto especifica el elemento HTML, usando un Selector de CSS hacer click. Recuerde que también puede ser necesario un retraso para ver los efectos del clic.
  • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
• setTargetElement(String value) - el Selector de CSS del único elemento HTML en la página web de destino que se va a convertir into una captura de pantalla, se ignoran todas las otras partes de la página web. Si hay varios elementos HTML coincidentes, se elige el primero.
  • Predeterminado: vacío
• setHideElement(String value) - el Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
  • Predeterminado: vacío
• setWaitForElement(String value) - el Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
  • Predeterminado: vacío
• setRequestAs(BrowserType value) - el tipo de agente de usuario que desea utilizar
  • Por defecto: BrowserType.BROWSER ESTÁNDAR
  • Opciones: BrowserType.BROWSER ESTÁNDAR, BrowserType.MOBILEBROWSER, BrowserType.BUSCADOR
• setCustomWaterMarkId(String value) - Agrega un personalizado watermark or especial watermark a la imagen
  • Predeterminado: vacío
• setQuality(int value) - el calidad de la imagen devuelta. Actualmente, esto solo afecta a las imágenes JPG y WEBP, que tienen una compresión predeterminada del 90%.
  • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
  • Predeterminado: -1
  • Mínimo: -1
  • Máxima: 100
• setTransparent(boolean value) - si es cierto el la captura de imagen debe ser transparente. Esto solo es compatible con imágenes png y tiff.
  • Predeterminado: falso
• setHd(boolean value) - si es verdad la imagen la captura será en alta definición esto duplica el tamaño de las dimensiones de la imagen.
  • Predeterminado: falso
• setCountry(Country value) - el país la captura de pantalla debe tomarse de.
  • Valor predeterminado: la ubicación más rápida actual
  • Opciones: País.SINGAPUR, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setNoAds(boolean noAds) - si es verdad los anuncios deben ocultarse automáticamente.
  • Predeterminado: falso
• setNoCookieNotifications(boolean noCookieNotifications) - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
  • Predeterminado: falso
• setAddress(String address) - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío

Métodos públicos

• AddPostParameter (String nombre, String valor) - define un parámetro HTTP Post y, opcionalmente, un valor, este método se puede llamar varias veces para agregar múltiples parámetros. El uso de este método obligará a GrabzIt a realizar una publicación HTTP.
  • nombre: el nombre del parámetro HTTP Post
  • valor: el valor del parámetro HTTP Post

---

URLToRenderedHTML(String url HTMLOptions opciones)

Especifica la URL que se debe convertir into HTML procesado.

parámetros

• url: la URL de la que debe estar hecho el HTML representado
  • Requerido
• opciones - una instancia de la HTMLOptions clase que define cualquier opción especial para usar al crear el HTML representado.

Valor de retorno

vacío

HTMLToRenderedHTML(string html, HTMLOptions opciones)

Especifica el HTML que se debe convertir into HTML procesado.

parámetros

• html - el HTML para convertir into HTML procesado
• opciones - una instancia de la HTMLOptions clase que define cualquier opción especial para usar al crear HTML renderizado.

Valor de retorno

vacío

FileToRenderedHTML(string camino, HTMLOptions opciones)

Especifica un archivo HTML que debe convertirse into HTML procesado.

parámetros

• ruta de acceso: la ruta del archivo HTML para convertir into HTML procesado
  • Requerido
• opciones - una instancia de la HTMLOptions clase que define cualquier opción especial para usar al crear HTML renderizado.

Valor de retorno

vacío

HTMLOptions

La clase representa todas las opciones disponibles cuando crear capturas HTML representadas.

Propiedades publicas

• setCustomId(String value) - Identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
  • Predeterminado: vacío
• setBrowserWidth(int value) - el ancho del navegador en píxeles
  • Predeterminado: 1366
  • Máxima: 10000
• setBrowserHeight(int value) - la altura del navegador en píxeles
  • Predeterminado: 1170
  • Máxima: 10000
• setWaitForElement(String value) - el Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
  • Predeterminado: vacío
• setRequestAs(BrowserType value) - el tipo de agente de usuario que desea utilizar
  • Por defecto: BrowserType.BROWSER ESTÁNDAR
  • Opciones: BrowserType.BROWSER ESTÁNDAR, BrowserType.MOBILEBROWSER, BrowserType.BUSCADOR
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setNoAds(boolean noAds) - si es verdad los anuncios deben ocultarse automáticamente.
  • Predeterminado: falso
• setNoCookieNotifications(boolean noCookieNotifications) - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
  • Predeterminado: falso
• setAddress(String address) - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío

Métodos públicos

• AddPostParameter (String nombre, String valor) - define un parámetro HTTP Post y, opcionalmente, un valor, este método se puede llamar varias veces para agregar múltiples parámetros. El uso de este método obligará a GrabzIt a realizar una publicación HTTP.
  • nombre: el nombre del parámetro HTTP Post
  • valor: el valor del parámetro HTTP Post

---

URLToPDF(String url PDFOpciones opciones)

Especifica la URL que se debe convertir intoa PDF.

parámetros

• url: la URL a la que se debe convertir intoa PDF
  • Requerido
• PDFOpciones opciones: una instancia de la clase PDFOptions que define las opciones especiales que se utilizarán al crear un PDF.

Valor de retorno

vacío

HTMLToPDF(String html, PDFOpciones opciones)

Especifica el HTML que se debe convertir intoa PDF.

parámetros

• html - el HTML para convertir intoa PDF
  • Requerido
• PDFOpciones opciones: una instancia de la clase PDFOptions que define las opciones especiales que se utilizarán al crear un PDF.

Valor de retorno

vacío

FileToPDF(String camino, PDFOpciones opciones)

Especifica un archivo HTML que debe convertirse intoa PDF.

parámetros

• ruta de acceso: la ruta del archivo HTML para convertir intoa PDF
  • Requerido
• PDFOpciones opciones: una instancia de la clase PDFOptions que define las opciones especiales que se utilizarán al crear un PDF.

Valor de retorno

vacío

PDFOpciones

La clase representa todas las opciones disponibles al crear capturas de PDF.

Propiedades publicas

• setCustomId(String value) - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
  • Predeterminado: vacío
• setIncludeBackground(boolean value) - si es cierto, el fondo de la página web debe incluirse en la captura de pantalla
  • Predeterminado: verdadero
• setPageSize(PageSize value) - el tamaño de página del PDF
  • Por defecto: PageSize.A4
  • Opciones: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.LETRA
• setOrientation(PageOrientation value) - la orientación del documento PDF
  • Por defecto: PageOrientation.RETRATO
  • Opciones: PageOrientation.RETRATO, PageOrientation.PAISAJE
• setCSSMediaType(CSSMediaType value) - el Tipo de medio CSS del documento PDF
  • Por defecto: CSSMediaType.PANTALLA
  • Opciones: CSSMediaType.PANTALLA, CSSMediaType.PRINT
• setIncludeLinks(boolean value) - verdadero si los enlaces deben incluirse en el PDF
  • Predeterminado: verdadero
• setIncludeOutline(boolean value) - cierto si Marcadores PDF debe ser incluido
  • Predeterminado: falso
• setTitle(String value) - proporcione un título para el documento PDF
  • Predeterminado: vacío
• setCoverURL(string value) - la URL de una página web que debe usarse como portada del PDF
  • Predeterminado: vacío
• setMarginTop(int value) - el margen en milímetros que debería aparecer en la parte superior de la página del documento PDF
  • Predeterminado: 10
• setMarginLeft(int value) - el margen en milímetros que debería aparecer a la izquierda de la página del documento PDF
  • Predeterminado: 10
• setMarginBottom(int value) - el margen en milímetros que debería aparecer en la parte inferior de la página del documento PDF
  • Predeterminado: 10
• setMarginRight(int value) - el margen en milímetros que debería aparecer a la derecha del documento PDF
  • Predeterminado: 10
• setBrowserWidth(int value) - la la ancho del navegador en píxeles
  • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
  • Predeterminado: 1366
  • Máxima: 10000
  • Ancho automático: -1 (pasar -1 significa que el ancho del navegador coincide con el ancho del documento PDF)
• setPageWidth(int value) - el ancho personalizado del PDF resultante en mm
  • Por defecto: PageSize anchura
  • Mínimo: 15
• setPageHeight(int value) - el altura personalizada del PDF resultante en mm
  • Por defecto: PageSize altura
  • Mínimo: 15
• setDelay(int value) - el número de milisegundos a espera antes de tomar la captura de pantalla
  • Predeterminado: 0
  • Máxima: 30000
• setRequestAs(BrowserType value) - el tipo de agente de usuario que desea utilizar
  • Por defecto: BrowserType.BROWSER ESTÁNDAR
  • Opciones: BrowserType.BROWSER ESTÁNDAR, BrowserType.MOBILEBROWSER, BrowserType.BUSCADOR
• setTemplateId(String value) - Agrega un plantilla ID que especifica el encabezado y pie de página del documento PDF
  • Predeterminado: vacío
• setClickElement - esto especifica el elemento HTML, usando un Selector de CSS hacer click. Recuerde que también puede ser necesario un retraso para ver los efectos del clic.
  • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
• setTargetElement(String value) - el Selector de CSS de los únicos Elemento HTML en la página web de destino que se va a convertir intoa PDF, todas las demás partes de la página web se ignoran. Si hay varios elementos HTML coincidentes, se elige el primero.
  • Predeterminado: vacío
• setHideElement(String value) - el Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
  • Predeterminado: vacío
• setWaitForElement(String value) - el Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
  • Predeterminado: vacío
• setCustomWaterMarkId(String value) - Agrega un personalizado watermark or especial watermark a cada página del documento PDF
  • Predeterminado: vacío
• setQuality(int value) - el calidad del PDF devuelto. El valor predeterminado utiliza la calidad recomendada para el PDF.
  • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
  • Predeterminado: -1
  • Mínimo: -1
  • Máxima: 100
• setCountry(Country value) - el país la captura de pantalla debe tomarse de.
  • Valor predeterminado: la ubicación más rápida actual
  • Opciones: País.SINGAPUR, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setNoAds(boolean noAds) - si es verdad los anuncios deben ocultarse automáticamente.
  • Predeterminado: falso
• setNoCookieNotifications(boolean noCookieNotifications) - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
  • Predeterminado: falso
• setAddress(String address) - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío
• setMergeId(String mergeId) - la identificación de una captura que debería ser fusionado al comienzo del nuevo documento PDF
  • Predeterminado: vacío
• setPassword(String password) - el contraseña para proteger el documento PDF
  • Predeterminado: vacío

Métodos públicos

• AddPostParameter (String nombre, String valor) - define un parámetro HTTP Post y, opcionalmente, un valor, este método se puede llamar varias veces para agregar múltiples parámetros. El uso de este método obligará a GrabzIt a realizar una publicación HTTP.
  • nombre: el nombre del parámetro HTTP Post
  • valor: el valor del parámetro HTTP Post
• AddTemplateParameter (String nombre, String valor) - definir un plantilla personalizada parámetro y valor, este método se puede llamar varias veces para agregar múltiples parámetros.
  • nombre: el nombre del parámetro de plantilla
  • valor: el valor del parámetro de plantilla

---

URLToDOCX (String url DOCXOptions opciones)

Especifica la URL que se debe convertir into DOCX.

parámetros

• url: la URL a la que se debe convertir intoa DOCX
  • Requerido
• DOCXOptions opciones: una instancia de DOCXOptions clase que define cualquier opción especial para usar al crear un DOCX.

Valor de retorno

vacío

HTMLToDOCX(String html, DOCXOptions opciones)

Especifica el HTML que se debe convertir into DOCX.

parámetros

• html - el HTML para convertir intoa DOCX
  • Requerido
• DOCXOptions opciones: una instancia de DOCXOptions clase que define cualquier opción especial para usar al crear un DOCX.

Valor de retorno

vacío

FileToDOCX(String camino, DOCXOptions opciones)

Especifica un archivo HTML que debe convertirse into DOCX.

parámetros

• ruta de acceso: la ruta del archivo HTML para convertir intoa DOCX
  • Requerido
• DOCXOptions opciones: una instancia de DOCXOptions clase que define cualquier opción especial para usar al crear un DOCX.

Valor de retorno

vacío

DOCXOptions

La clase representa todas las opciones disponibles al crear capturas DOCX.

Propiedades publicas

• setCustomId(String value) - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
  • Predeterminado: vacío
• setIncludeBackground(boolean value) - si es cierto, las imágenes de fondo de la página web deben incluirse en el DOCX
  • Predeterminado: verdadero
• setPageSize(PageSize value) - el tamaño de página del DOCX
  • Por defecto: PageSize.A4
  • Opciones: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.LETRA
• setOrientation(PageOrientation value) - la orientación del documento DOCX
  • Por defecto: PageOrientation.RETRATO
  • Opciones: PageOrientation.RETRATO, PageOrientation.PAISAJE
• setIncludeLinks(boolean value) - verdadero si los enlaces deben incluirse en el DOCX
  • Predeterminado: verdadero
• setIncludeImages(boolean value) - si es cierto, las imágenes de la página web deben incluirse en el DOCX
  • Predeterminado: verdadero
• setTitle(String value) - proporcione un título para el documento DOCX
  • Predeterminado: vacío
• setMarginTop(int value) - el margen en milímetros que debería aparecer en la parte superior de la página del documento DOCX
  • Predeterminado: 10
• setMarginLeft(int value) - el margen en milímetros que debería aparecer a la izquierda de la página del documento DOCX
  • Predeterminado: 10
• setMarginBottom(int value) - el margen en milímetros que debería aparecer en la parte inferior de la página del documento DOCX
  • Predeterminado: 10
• setMarginRight(int value) - el margen en milímetros que debería aparecer a la derecha del documento DOCX
  • Predeterminado: 10
• setBrowserWidth(int value) - el ancho del navegador en píxeles
  • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
  • Predeterminado: 1366
  • Máxima: 10000
  • Ancho automático: -1 (pasar -1 significa que el ancho del navegador coincide con el ancho del documento PDF)
• setPageWidth(int value) - el ancho personalizado del DOCX resultante en mm
  • Por defecto: PageSize anchura
  • Mínimo: 15
• setPageHeight(int value) - el altura personalizada del DOCX resultante en mm
  • Por defecto: PageSize altura
  • Mínimo: 15
• setDelay(int value) - el número de milisegundos a espera antes de tomar la captura de pantalla
  • Predeterminado: 0
  • Máxima: 30000
• setRequestAs(BrowserType value) - el tipo de agente de usuario que desea utilizar
  • Por defecto: BrowserType.BROWSER ESTÁNDAR
  • Opciones: BrowserType.BROWSER ESTÁNDAR, BrowserType.MOBILEBROWSER, BrowserType.BUSCADOR
• setTemplateId(String value) - Agrega un plantilla ID que especifica el encabezado y pie de página del documento DOCX
  • Predeterminado: vacío
• setClickElement - esto especifica el elemento HTML, usando un Selector de CSS hacer click. Recuerde que también puede ser necesario un retraso para ver los efectos del clic.
  • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
• setTargetElement(String value) - el Selector de CSS del único elemento HTML en la página web de destino que se va a convertir into una captura de pantalla, se ignoran todas las otras partes de la página web. Si hay varios elementos HTML coincidentes, se elige el primero.
  • Predeterminado: vacío
• setHideElement(String value) - el Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
  • Predeterminado: vacío
• setWaitForElement(String value) - el Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
  • Predeterminado: vacío
• setQuality(int value) - el calidad del DOCX devuelto. El valor predeterminado utiliza la calidad recomendada para el DOCX.
  • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
  • Predeterminado: -1
  • Mínimo: -1
  • Máxima: 100
• setCountry(Country value) - el país la captura de pantalla debe tomarse de.
  • Valor predeterminado: la ubicación más rápida actual
  • Opciones: País.SINGAPUR, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setNoAds(boolean noAds) - si es verdad los anuncios deben ocultarse automáticamente.
  • Predeterminado: falso
• setNoCookieNotifications(boolean noCookieNotifications) - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
  • Predeterminado: falso
• setAddress(String address) - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío
• setMergeId(String mergeId) - la identificación de una captura que debería ser fusionado al comienzo del nuevo documento DOCX
  • Predeterminado: vacío
• setPassword(String mergeId) - el contraseña para proteger el documento DOCX
  • Predeterminado: vacío

Métodos públicos

• AddPostParameter (String nombre, String valor) - define un parámetro HTTP Post y, opcionalmente, un valor, este método se puede llamar varias veces para agregar múltiples parámetros. El uso de este método obligará a GrabzIt a realizar una publicación HTTP.
  • nombre: el nombre del parámetro HTTP Post
  • valor: el valor del parámetro HTTP Post
• AddTemplateParameter (String nombre, String valor) - definir un plantilla personalizada parámetro y valor, este método se puede llamar varias veces para agregar múltiples parámetros.
  • nombre: el nombre del parámetro de plantilla
  • valor: el valor del parámetro de plantilla

---

URLToTable(String url TableOptions opciones)

Especifica la URL de la que se deben extraer las tablas HTML.

parámetros

• url: la URL para extraer tablas HTML de
  • Requerido
• TableOptions opciones: una instancia de TableOptions clase que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

HTMLToTable (String html, TableOptions opciones)

Especifica el HTML del que se deben extraer las tablas HTML.

parámetros

• html: el HTML para extraer tablas HTML de.
  • Requerido
• TableOptions opciones: una instancia de TableOptions clase que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

FileToTable (String camino, TableOptions opciones)

Especifica un archivo HTML del que se deben extraer las tablas HTML.

parámetros

• ruta: la ruta del archivo HTML para extraer tablas HTML.
  • Requerido
• TableOptions opciones: una instancia de TableOptions clase que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

TableOptions

La clase representa todas las opciones disponibles al convertir tablas HTML a CSV, XLSX o JSON.

Propiedades publicas

• setCustomId(String value) - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado
  • Predeterminado: vacío
• setTableNumberToInclude(int value) - el índice de la tabla que se convertirá, si todas las tablas de una página web se ordenan de arriba a abajo
  • Predeterminado: 1
• setFormat(TableFormat value) - el formato en que debe estar la tabla
  • Por defecto: TableFormat.CSV
  • Opciones: TableFormat.CSV, TableFormat.JSON, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - si se incluirán nombres verdaderos de encabezado en la tabla
  • Predeterminado: verdadero
• setIncludeAllTables(boolean value) - si es verdadero, todas las tablas de la página web se extraerán y cada tabla aparecerá en una hoja de cálculo separada. Solo disponible con el formato XLSX
  • Predeterminado: falso
• setTargetElement(String value) - la identificación del único elemento HTML en la página web que debe usarse para extraer tablas de
  • Predeterminado: vacío
• setRequestAs(BrowserType value) - el tipo de agente de usuario que desea utilizar
  • Por defecto: BrowserType.BROWSER ESTÁNDAR
  • Opciones: BrowserType.BROWSER ESTÁNDAR, BrowserType.MOBILEBROWSER, BrowserType.BUSCADOR
• setCountry(Country value) - el país la captura de pantalla debe tomarse de.
  • Valor predeterminado: la ubicación más rápida actual
  • Opciones: País.SINGAPUR, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - el exportar URL que especifica dónde se debe exportar la captura también
  • Predeterminado: vacío
• setEncryptionKey(String key) - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
  • Predeterminado: vacío
• setAddress(String address) - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
  • Predeterminado: vacío
• setProxy(String proxy) - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
  • Predeterminado: vacío

Métodos públicos

• AddPostParameter (String nombre, String valor) - define un parámetro HTTP Post y, opcionalmente, un valor, este método se puede llamar varias veces para agregar múltiples parámetros. El uso de este método obligará a GrabzIt a realizar una publicación HTTP.
  • nombre: el nombre del parámetro HTTP Post
  • valor: el valor del parámetro HTTP Post

---

Save()

Save el resultado de forma asincrónica y devuelve un identificador único, que se puede utilizar para obtener la captura de pantalla con el GetResult método.

Valor de retorno

El identificador único de la captura de pantalla, de lo contrario, si se produce un error, se genera una excepción. Esto se puede usar para obtener la captura de pantalla con el GetResult Método

---

Save(String callBackURL)

Save el resultado de forma asincrónica y devuelve un identificador único, que se puede utilizar para obtener la captura de pantalla con el GetResult método.

parámetros

• callBackURL - el entrenador de animales el servicio GrabzIt debería llamar después de haber completado su trabajo
  • Requerido

Valor de retorno

El identificador único de la captura de pantalla, de lo contrario, si se produce un error, se genera una excepción. Esto se puede usar para obtener la captura de pantalla con el GetResult Método

GrabzItFile SaveTo()

Save el resultado sincrónicamente a un GrabzItFile objeto.

Valor de retorno

GrabzItFile objeto

---

SaveTo(String saveToExpediente)

Save el resultado sincrónicamente a un archivo.

parámetros

• saveToArchivo: la ruta del archivo que captura será saved una vez que se ha completado
  • Requerido

Valor de retorno

devuelve el verdadero si tiene éxito; de lo contrario, arroja una excepción.

---

Estado Obtener el estado(String carné de identidad)

Obtenga el estado actual de una captura de pantalla de GrabzIt.

parámetros

• id: el identificador único de la captura de pantalla
  • Requerido

Valor de retorno

Estado objeto

---

GrabzItCookie [] GetCookies (String dominio)

Obtenga todas las cookies que GrabzIt está utilizando para un dominio en particular. Esto también puede incluir cookies definidas por el usuario.

parámetros

• dominio: el dominio para devolver cookies
  • Requerido

Valor de retorno

GrabzItCookie matriz

---

SetCookie (String nombre, String dominio, String valor, String camino, boolean httponly, la fecha expira)

Establece una nueva cookie personalizada en GrabzIt, si la cookie personalizada tiene el mismo nombre y dominio que una cookie global, la cookie global se anula.

Esto puede ser útil si la funcionalidad de un sitio web está controlada por cookies.

parámetros

• nombre: el nombre de la cookie para establecer
  • Requerido
• dominio: el dominio del sitio web para configurar la cookie
  • Requerido
• valor - el valor de la cookie
• ruta: la ruta del sitio web con la que se relaciona la cookie
• httponly: si es verdadero, la cookie solo se puede usar con el protocolo HTTP
• caduca: define cuándo caduca la cookie. Pase un valor nulo si la cookie no caduca

Valor de retorno

Verdadero si la cookie se ha configurado correctamente; de ​​lo contrario, falso

---

DeleteCookie (String nombre, String dominio)

Eliminar una cookie personalizada o bloquear el uso de una cookie global

parámetros

• nombre: el nombre de la cookie a eliminar
  • Requerido
• dominio: el dominio del sitio web para eliminar la cookie
  • Requerido

Valor de retorno

Verdadero si la cookie se elimina correctamente; de ​​lo contrario, falso

---

WaterMark[] GetWaterMarks()

Obtén todas tus subidas personalizadas watermarks

Valor de retorno

WaterMark matriz

---

WaterMark GetWaterMark(String identificador)

Devuelve tu costumbre watermarks que coincide con el identificador especificado

parámetros

• identificador: el identificador de una costumbre en particular watermark quieres ver
  • Requerido

Valor de retorno

WaterMark objeto

---

AñadaWaterMark(String identificador, String camino, HorizontalPosition xpos, VerticalPosition ypos)

Agregar una nueva costumbre watermark

parámetros

• identificador: el identificador que desea dar al personalizado watermark. Es importante que este identificador sea único.
  • Requerido
• ruta - la ruta absoluta de la watermark en su servidor. Por ejemplo C: /watermark/1.png
  • Requerido
• xpos: la posición horizontal en la que desea que aparezca la captura de pantalla
  • Requerido
  • Opciones: HorizontalPosition.IZQUIERDA, HorizontalPosition.CENTRAR, HorizontalPosition.DERECHO
• ypos: posición vertical en la que desea que aparezca la captura de pantalla
  • Requerido
  • Opciones: VerticalPosition.PARTE SUPERIOR, VerticalPosition.MEDIO, VerticalPosition.FONDO

Valor de retorno

devuelve verdadero si el watermark se configuró con éxito

---

DeleteWaterMark(String identificador)

Eliminar una costumbre watermark

parámetros

• identificador: el identificador de la costumbre watermark quieres borrar
  • Requerido

Valor de retorno

devuelve verdadero si el watermark fue eliminado con éxito

---

SetLocalProxy (String proxyUrl)

Este método permite un servidor proxy local para ser utilizado para todas las solicitudes.

parámetros

• proxyUrl: la URL, que puede incluir un puerto si es necesario, del proxy. Proporcionar un valor nulo eliminará cualquier proxy establecido previamente
  • Requerido

---

UseSSL (boolean valor)

Especifica si las solicitudes a GrabzIt's API debe usar SSL

parámetros

• valor: si es verdadero, todas las solicitudes a la API de GrabzIt utilizarán SSL
  • Requerido

---

String CreateEncryptionKey ()

Cree una clave de cifrado 64 base criptográficamente segura, con caracteres 44 largos.

---

Descifrar (String camino, String llave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros

• ruta: la ruta de la captura cifrada
  • Requerido
• clave - la Clave de encriptación
  • Requerido

---

GrabzItFile Descifrar (GrabzItFile archivo, String llave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros

• archivo - el cifrado GrabzItFile
  • Requerido
• clave - la Clave de encriptación
  • Requerido

---

byte [] Descifrar (datos de byte [], String llave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros

• datos: los bytes cifrados
  • Requerido
• clave - la Clave de encriptación
  • Requerido

---

Enumeraciones

ImageFormat

Esta enumeración consta de los siguientes valores.

• BMP8
• BMP16
• BMP24
• BMP
• JPG
• TIFF
• PNG
• WEBP

---

BrowserType

Esta enumeración consta de los siguientes valores.

• NORMATIVA ESTÁNDAR
• NAVEGADOR MÓVIL
• BUSCADOR

---

País

Esta enumeración consta de los siguientes valores.

• DEFAULT
• SINGAPUR
• REINO UNIDO
• ESTADOS UNIDOS

---

PageSize

Esta enumeración consta de los siguientes valores.

• A3
• A4
• A5
• A6
• B3
• B4
• B5
• B6
• LEGAL
• CARTA

---

PageOrientation

Esta enumeración consta de los siguientes valores.

• PAISAJE
• RETRATO

---

CSSMediaType

Esta enumeración consta de los siguientes valores.

• PRINT
• PANTALLA

---

TableFormat

Esta enumeración consta de los siguientes valores.

• CSV
• JSON
• XSLX

---

HorizontalPosition

Esta enumeración consta de los siguientes valores.

• IZQUIERDA
• INNOVACIÓN
• DERECHO

---

VerticalPosition

Esta enumeración consta de los siguientes valores.

• ARRIBA
• ED. MEDIA
• PARTE INFERIOR

---

Clases de resultados

Cookies

Propiedades publicas

• String getName()
  • El nombre de la cookie.
• String getValue()
  • El valor de la cookie.
• String getDomain()
  • El dominio para el que está configurada la cookie.
• String getPath()
  • La ruta en el dominio al que se aplica esta cookie.
• String getHttpOnly()
  • Si esta cookie solo es válida cuando el sitio web se visualiza con el protocolo HTTP.
• String getExpires()
  • La fecha de caducidad de esta cookie.
• String getType()
  • El tipo de cookie es este, que puede ser uno de los siguientes:
    • Global: esta es una cookie global establecida por GrabzIt
    • Local: esta es una cookie local establecida por usted
    • Anulada: una cookie global que usted ha anulado

GrabzItFile

Métodos públicos

• byte [] getBytes ()
• vacío Save(String camino)
• String aString()

Estado

La clase que representa el estado actual de la captura de pantalla.

Métodos públicos

• boolean isProcessing ()
  • Si es cierto, la captura de pantalla aún se está procesando.
• boolean isCached ()
  • Si es verdadero, la captura de pantalla se ha procesado y actualmente está en caché.
• boolean Está expirado()
  • Si es cierto, la captura de pantalla ya no está en el sistema GrabzIt.
• String getMessage ()
  • Un mensaje de error devuelto por el sistema.

WaterMark

Esta clase representa la costumbre watermarks almacenado en GrabzIt

Métodos públicos

• String getIdentifier ()
• String getFormat ()
• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()