Ferramentas para capturar e converter a Web

Cliente GrabzIt com Ruby

API Ruby

Descrição

Esta classe lida com toda a comunicação com os serviços da Web de captura de tela GrabzIt.

Métodos públicos

get_result (id)

Este método retorna a própria captura de tela. Se nada for retornado, algo deu errado ou a captura de tela ainda não está pronta.

parâmetros

Valor de retorno

A captura


url_to_animation(url, opções = nulo)

Especifique o URL do vídeo online que deve ser convertido intum GIF animado.

parâmetros

Valor de retorno

anular

AnimationOptions

A classe representa todas as opções disponíveis ao criar um GIF animado.

Propriedades Públicas


url_to_image(url, opções = nulo)

Especifica o URL que deve ser convertido intuma captura de tela da imagem.

parâmetros

Valor de retorno

anular

html_to_image(html, opções = nulo)

Especifica o HTML que deve ser convertido intuma imagem.

parâmetros

Valor de retorno

anular

file_to_image(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido intuma imagem.

parâmetros

Valor de retorno

anular

ImageOptions

A classe representa todas as opções disponíveis ao criar capturas de imagens.

Propriedades Públicas

Métodos públicos


url_para_vídeo(url, opções = nulo)

Especifica o URL que deve ser convertido intah vídeo.

parâmetros

Valor de retorno

anular

html_to_video(html, opções = nulo)

Especifica o HTML do qual o vídeo deve ser capturado.

parâmetros

Valor de retorno

anular

arquivo_para_vídeo(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido intah vídeo.

parâmetros

Valor de retorno

anular

Opções de vídeo

A classe representa todas as opções disponíveis quando criando um vídeo de uma página da web.

Propriedades Públicas

Métodos públicos


url_to_rendered_html(url, opções = nulo)

Especifica o URL que deve ser convertido into HTML renderizado.

parâmetros

Valor de retorno

anular

html_to_rendered_html(html, opções = nulo)

Especifica o HTML que deve ser convertido into HTML renderizado.

parâmetros

Valor de retorno

anular

file_to_rendered_html(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido into HTML renderizado.

parâmetros

Valor de retorno

anular

HTMLOptions

A classe representa todas as opções disponíveis quando criando capturas HTML renderizadas.

Propriedades Públicas

Métodos públicos


url_to_pdf(url, opções = nulo)

Especifica o URL que deve ser convertido intum PDF.

parâmetros

Valor de retorno

anular

html_to_pdf(html, opções = nulo)

Especifica o HTML que deve ser convertido intum PDF.

parâmetros

Valor de retorno

anular

file_to_pdf(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido intum PDF.

parâmetros

Valor de retorno

anular

PDFOptions

A classe representa todas as opções disponíveis ao criar capturas de PDF.

Propriedades Públicas

Métodos públicos


url_to_docx(url, opções = nulo)

Especifica o URL que deve ser convertido into DOCX.

parâmetros

Valor de retorno

anular

html_to_docx(html, opções = nulo)

Especifica o HTML que deve ser convertido into DOCX.

parâmetros

Valor de retorno

anular

file_to_docx(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido into DOCX.

parâmetros

Valor de retorno

anular

DOCXOptions

A classe representa todas as opções disponíveis ao criar capturas de DOCX.

Propriedades Públicas

Métodos públicos


url_to_table(url, opções = nulo)

Especifica a URL da qual as tabelas HTML devem ser extraídas.

parâmetros

Valor de retorno

anular

html_to_table(html, opções = nulo)

Especifica o HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

Valor de retorno

anular

file_to_table(caminho, opções = nulo)

Especifica um arquivo HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

Valor de retorno

anular

TableOptions

A classe representa todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.

Propriedades Públicas

Métodos públicos


Este é o método recomendado para salvar um arquivo

save(callBackURL = nulo)

Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o get_result método.

parâmetros

Valor de retorno

O identificador exclusivo da captura de tela, caso contrário, se ocorrer um erro, uma exceção será lançada. Isso pode ser usado para obter a captura de tela com o método get_result


Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado

save_to()

Save o resultado de forma síncrona com uma variável que contém os dados dos bytes da captura de tela.

Valor de retorno

retorna os dados de bytes do arquivo, se for bem-sucedido, caso contrário, lança uma exceção.


Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado

save_to(saveToArquivo)

Save o resultado de forma síncrona com um arquivo.

parâmetros

Valor de retorno

retorna true se for bem-sucedido, caso contrário, lança uma exceção.


get_status(identidade)

Obtenha o status atual de uma captura de tela do GrabzIt.

parâmetros

Valor de retorno

ScreenShotStatus objeto


get_cookies(domínio)

Obtenha todos os cookies que o GrabzIt está usando para um domínio específico. Isso também pode incluir cookies definidos pelo usuário.

parâmetros

Valor de retorno

Cookie ordem


set_cookie (nome, domínio, valor = "", caminho = "/", activationponly = false, expira = "")

Define um novo cookie personalizado no GrabzIt. Se o cookie personalizado tiver o mesmo nome e domínio que um cookie global, o cookie global será substituído.

Isso pode ser útil se a funcionalidade de um site for controlada por cookies.

parâmetros

Valor de retorno

Verdadeiro se o cookie for definido com êxito, caso contrário, falso


delete_cookie (nome, domínio)

Excluir um cookie personalizado ou impedir que um cookie global seja usado

parâmetros

Valor de retorno

Verdadeiro se o cookie for excluído com êxito, caso contrário, falso


pegue_watermarks()

Obtenha seu personalizado enviado watermarks

Valor de retorno

WaterMark ordem


pegue_watermark(identificador)

Obtenha seu personalizado enviado watermarks

parâmetros

Valor de retorno

WaterMark


adicionar_watermark(identificador, caminho, xpos, ypos)

Adicionar um novo personalizado watermark

parâmetros

Valor de retorno

retorna verdadeiro se o watermark foi definido com sucesso


excluir_watermark(identificador)

Excluir um personalizado watermark

parâmetros

Valor de retorno

retorna verdadeiro se o watermark foi excluído com sucesso


set_local_proxy (valor)

Este método permite uma servidor proxy local para ser usado para todas as solicitações.

parâmetros


use_ssl (valor)

Especifica se as solicitações ao GrabzIt API deve usar SSL

parâmetros


create_encryption_key ()

Crie uma chave de criptografia 64 básica com criptografia segura, com caracteres 44.


descriptografar (dados, chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros


decrypt_file (caminho, chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros


Classes de resultado

Cookie

Propriedades Públicas

ScreenShotStatus

A classe que representa o status atual da captura de tela.

Propriedades Públicas

WaterMark

Esta classe representa o costume watermarks armazenado no GrabzIt

Propriedades Públicas