Herramientas para capturar y convertir la web

Cliente GrabzIt con Ruby

API de rubí

Descripción

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

Métodos públicos

get_result (id)

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

Valor de retorno

La captura


url_to_animation(url, opciones = nulo)

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

parámetros

Valor de retorno

vacío

AnimationOptions

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

Propiedades publicas


url_to_image(url, opciones = nulo)

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

parámetros

Valor de retorno

vacío

html_to_image(html, opciones = nulo)

Especifica el HTML que se debe convertir intuna imagen

parámetros

Valor de retorno

vacío

file_to_image(camino, opciones = nulo)

Especifica un archivo HTML que debe convertirse intuna imagen

parámetros

Valor de retorno

vacío

ImageOptions

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

Propiedades publicas

Métodos públicos


url_to_rendered_html(url, opciones = nulo)

Especifica la URL que se debe convertir into HTML procesado.

parámetros

Valor de retorno

vacío

html_to_rendered_html(html, opciones = nulo)

Especifica el HTML que se debe convertir into HTML procesado.

parámetros

Valor de retorno

vacío

file_to_rendered_html(camino, opciones = nulo)

Especifica un archivo HTML que debe convertirse into HTML procesado.

parámetros

Valor de retorno

vacío

HTMLOptions

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

Propiedades publicas

Métodos públicos


url_to_pdf(url, opciones = nulo)

Especifica la URL que se debe convertir intoa PDF.

parámetros

Valor de retorno

vacío

html_to_pdf(html, opciones = nulo)

Especifica el HTML que se debe convertir intoa PDF.

parámetros

Valor de retorno

vacío

file_to_pdf(camino, opciones = nulo)

Especifica un archivo HTML que debe convertirse intoa PDF.

parámetros

Valor de retorno

vacío

PDFOpciones

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

Propiedades publicas

Métodos públicos


url_to_docx(url, opciones = nulo)

Especifica la URL que se debe convertir into DOCX.

parámetros

Valor de retorno

vacío

html_to_docx(html, opciones = nulo)

Especifica el HTML que se debe convertir into DOCX.

parámetros

Valor de retorno

vacío

file_to_docx(camino, opciones = nulo)

Especifica un archivo HTML que debe convertirse into DOCX.

parámetros

Valor de retorno

vacío

DOCXOptions

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

Propiedades publicas

Métodos públicos


url_to_table(url, opciones = nulo)

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

parámetros

Valor de retorno

vacío

html_to_table(html, opciones = nulo)

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

parámetros

Valor de retorno

vacío

file_to_table(camino, opciones = nulo)

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

parámetros

Valor de retorno

vacío

TableOptions

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

Propiedades publicas

Métodos públicos


Este es el método recomendado para guardar un archivo

save(callBackURL = nil)

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

parámetros

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 método get_result


Advertencia: este método es sincrónico, por lo que hará que una aplicación se detenga mientras se procesa el resultado

save_to()

Save el resultado sincrónicamente a una variable que contiene los datos del byte de captura de pantalla.

Valor de retorno

devuelve los datos de bytes del archivo si tiene éxito; de lo contrario, arroja una excepción.


Advertencia: este método es sincrónico, por lo que hará que una aplicación se detenga mientras se procesa el resultado

save_to(saveToExpediente)

Save el resultado sincrónicamente a un archivo.

parámetros

Valor de retorno

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


get_status(carné de identidad)

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

parámetros

Valor de retorno

ScreenShotStatus objeto


get_cookies(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

Valor de retorno

Galletas matriz


set_cookie (nombre, dominio, valor = "", ruta = "/", httponly = false, caduca = "")

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

Valor de retorno

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


delete_cookie (nombre, dominio)

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

parámetros

Valor de retorno

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


obtener_watermarks()

Obtenga su personalizado subido watermarks

Valor de retorno

WaterMark matriz


obtener_watermark(identificador)

Obtenga su personalizado subido watermarks

parámetros

Valor de retorno

WaterMark


añadir_watermark(identificador, ruta, xpos, ypos)

Agregar una nueva costumbre watermark

parámetros

Valor de retorno

devuelve verdadero si el watermark se configuró con éxito


Eliminar_watermark(identificador)

Eliminar una costumbre watermark

parámetros

Valor de retorno

devuelve verdadero si el watermark fue eliminado con éxito


set_local_proxy (valor)

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

parámetros


use_ssl (valor)

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

parámetros


create_encryption_key ()

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


descifrar (datos, clave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros


decrypt_file (ruta, clave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros


Clases de resultados

Galletas

Propiedades publicas

ScreenShotStatus

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

Propiedades publicas

WaterMark

Esta clase representa la costumbre watermarks almacenado en GrabzIt

Propiedades publicas