Ferramentas para capturar e converter a Web

Cliente GrabzIt com RubyAPI 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

  • id - o identificador exclusivo da captura de tela
    • Exigido

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

  • url - o URL do vídeo online a ser convertido into um GIF animado.
    • Exigido
    • Aceita URLs de vídeo do Vimeo e do YouTube
      • O aviso de animação de vídeos do Vimeo e do YouTube depende de terceiros e, portanto, pode não fornecer resultados consistentes.
  • opções - uma instância do AnimationOptions classe que define todas as opções especiais a serem usadas ao criar o GIF animado.

Valor de retorno

anular

AnimationOptions

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

Propriedades Públicas

  • customId - identificador personalizado pelo qual você pode passar para o serviço da web GIF animado. Isso será retornado com o URL de retorno que você especificou.
    • Padrão: vazio
  • width - a largura do GIF animado resultante em pixels.
    • Padrão: 180px
    • Máximo: Largura máxima para o pacote
    • Tamanho automático: -1 (passar -1 significa que a largura do GIF animado é redimensionado em relação à sua altura, se a largura estiver sendo dimensionada automaticamente, a altura não poderá)
  • height - a altura do GIF animado resultante em pixels.
    • Padrão: 120px
    • Máximo: Altura máxima para o pacote
    • Tamanho automático: -1 (passar -1 significa que a altura do GIF animado é redimensionado em relação à sua largura, se a altura estiver sendo dimensionada automaticamente, a largura não poderá)
  • start - a posição inicial do vídeo que deve ser convertida intum GIF animado.
    • Padrão: 0 segundos
  • duration - a duração em segundos do vídeo que deve ser convertido intum GIF animado.
    • Padrão: comprimento máximo para o pacote
  • speed - a velocidade do GIF animado.
    • Padrão: 1
    • Mínimo: 0.2
    • Máximo: 10
  • framesPerSecond - o número de quadros por segundo que devem ser capturados do vídeo.
    • Padrão: 10
    • Mínimo: 0.2
    • Máximo: 60
  • repeat - número de vezes para repetir o GIF animado.
    • Padrão: 0
    • Loop continuamente: 0
  • reverse - se verdadeiro, os quadros do GIF animado são revertidos
    • Padrão: false
  • customWaterMarkId - adicione marca d'água personalizada ao GIF animado
    • Padrão: vazio
  • quality - a qualidade da imagem retornada, que possui uma compactação padrão de 85%.
    • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
    • Padrão: -1
    • Mínimo: -1
    • Máximo: 100
  • country - o país o GIF animado deve ser retirado.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio

url_to_image(url, opções = nulo)

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

parâmetros

  • url - o URL do qual a captura de tela deve ser feita
    • Exigido
  • opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar a captura de tela.

Valor de retorno

anular

html_to_image(html, opções = nulo)

Especifica o HTML que deve ser convertido intuma imagem.

parâmetros

  • html - o HTML para converter intoa imagem
    • Exigido
  • opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

file_to_image(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido intuma imagem.

parâmetros

  • path - o caminho do arquivo HTML para converter intoa imagem
    • Exigido
  • opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

ImageOptions

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

Propriedades Públicas

  • customId - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
    • Padrão: vazio
  • browserWidth - a largura do navegador em pixels
    • Padrão: 1024
    • Máximo: 10000
  • browserHeight - a altura do navegador em pixels
    • Padrão: 768
    • Máximo: 10000
    • Comprimento total: -1 (passar -1 significa que é feita uma captura de tela de toda a página da web)
  • width - a largura da miniatura resultante em pixels
    • Padrão: a maior proporção possível da largura do navegador que se ajusta à largura máxima do pacote de usuários
    • Máximo: Largura máxima para o pacote
    • Largura total: -1 (passar -1 significa que a largura da miniatura não é reduzida)
  • height - a altura da miniatura resultante em pixels
    • Padrão: a maior proporção possível da altura do navegador que se ajusta à altura máxima do pacote de usuários
    • Máximo: Altura máxima para o pacote
    • Altura total: -1 (passar -1 significa que a altura da miniatura não é reduzida)
  • format - o formato em que a captura de tela deve estar.
    • Padrão: "jpg"
    • Opções: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
  • delay - o número de milissegundos a aguarde antes de tirar a captura de tela
    • Padrão: 0
    • Máximo: 30000
  • targetElement - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into uma captura de tela, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
    • Padrão: vazio
  • hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
    • Padrão: vazio
  • waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
    • Padrão: vazio
  • requestAs - o tipo de agente do usuário que você deseja usar
    • Padrão: 0
    • opções:
      • 0 = indica que o agente do usuário de um navegador padrão deve ser usado
      • 1 = indica que o agente do usuário de um navegador móvel deve ser usado
      • 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
  • customWaterMarkId - adicione uma marca d'água personalizada à imagem
    • Padrão: vazio
  • quality - a qualidade da imagem retornada. Atualmente, isso afeta apenas imagens JPG e WEBP, que têm uma compactação padrão de 90%.
    • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
    • Padrão: -1
    • Mínimo: -1
    • Máximo: 100
  • transparent - se verdadeiro, o a captura de imagem deve ser transparente. Isso é compatível apenas com imagens png e tiff.
    • Padrão: false
  • hd - se verdadeira a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
    • Padrão: false
  • country - o país a captura de tela deve ser retirada.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • noAds - se for verdade anúncios devem ser ocultados automaticamente.
    • Padrão: false
  • noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
    • Padrão: false
  • address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio

Métodos públicos

  • add_post_parameter (nome, valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
    • name - o nome do parâmetro HTTP Post
    • value - o valor do parâmetro HTTP Post

url_to_rendered_html(url, opções = nulo)

Especifica o URL que deve ser convertido into HTML renderizado.

parâmetros

  • url - a URL da qual o HTML renderizado deve ser feito
    • Exigido
  • opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar o HTML renderizado.

Valor de retorno

anular

html_to_rendered_html(html, opções = nulo)

Especifica o HTML que deve ser convertido into HTML renderizado.

parâmetros

  • html - o HTML para converter into HTML renderizado
    • Exigido
  • opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.

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

  • path - o caminho do arquivo HTML para converter into HTML renderizado
    • Exigido
  • opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.

Valor de retorno

anular

HTMLOptions

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

Propriedades Públicas

  • customId - identificador personalizado que você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
    • Padrão: vazio
  • browserWidth - a largura do navegador em pixels
    • Padrão: 1024
    • Máximo: 10000
  • browserHeight - a altura do navegador em pixels
    • Padrão: 768
    • Máximo: 10000
  • waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
    • Padrão: vazio
  • requestAs - o tipo de agente do usuário que você deseja usar
    • Padrão: 0
    • opções:
      • 0 = indica que o agente do usuário de um navegador padrão deve ser usado
      • 1 = indica que o agente do usuário de um navegador móvel deve ser usado
      • 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
  • country - o país a captura de tela deve ser retirada.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • noAds - se for verdade anúncios devem ser ocultados automaticamente.
    • Padrão: false
  • noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
    • Padrão: false
  • address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio

Métodos públicos

  • add_post_parameter (nome, valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
    • name - o nome do parâmetro HTTP Post
    • value - o valor do parâmetro HTTP Post

url_to_pdf(url, opções = nulo)

Especifica o URL que deve ser convertido intum PDF.

parâmetros

  • url - o URL que deve ser convertido intoa PDF
    • Exigido
  • opções - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

html_to_pdf(html, opções = nulo)

Especifica o HTML que deve ser convertido intum PDF.

parâmetros

  • html - o HTML para converter intoa PDF
    • Exigido
  • opções - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

file_to_pdf(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido intum PDF.

parâmetros

  • path - o caminho do arquivo HTML para converter intoa PDF
    • Exigido
  • opções - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

PDFOptions

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

Propriedades Públicas

  • customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
    • Padrão: vazio
  • includeBackground - se verdadeiro, o plano de fundo da página da web deve ser incluído na captura de tela
    • Padrão: true
  • pagesize - o tamanho da página do PDF
    • Padrão: "A4"
    • Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
  • orientation - a orientação do documento PDF
    • Padrão: "Retrato"
    • Opções: "Retrato", "Paisagem"
  • cssMediaType - a Tipo de mídia CSS do documento PDF
    • Tela padrão"
    • Opções: "Tela", "Print"
  • includeLinks - true se os links devem ser incluídos no PDF
    • Padrão: true
  • includeOutline - verdadeiro se Favoritos em PDF Deveria ser incluído
    • Padrão: false
  • title - forneça um título para o documento PDF
    • Padrão: vazio
  • coverURL - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
    • Padrão: vazio
  • marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
    • Padrão: 10
  • marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
    • Padrão: 10
  • marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
    • Padrão: 10
  • marginRight - a margem em milímetros que deve aparecer à direita do documento PDF
    • Padrão: 10
  • browserWidth - a largura do navegador em pixels
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: 1024
    • Máximo: 10000
    • Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento PDF)
  • pageWidth - a largura personalizada do PDF resultante em mm
  • pageHeight - a altura personalizada do PDF resultante em mm
  • delay - o número de milissegundos a aguarde antes de tirar a captura de tela
    • Padrão: 0
    • Máximo: 30000
  • requestAs - o tipo de agente do usuário que você deseja usar
    • Padrão: 0
    • opções:
      • 0 = indica que o agente do usuário de um navegador padrão deve ser usado
      • 1 = indica que o agente do usuário de um navegador móvel deve ser usado
      • 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
  • templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
    • Padrão: vazio
  • targetElement - a Seletor CSS dos únicos Elemento HTML na página da web de destino a ser ativada intoa PDF, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
    • Padrão: vazio
  • hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
    • Padrão: vazio
  • waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
    • Padrão: vazio
  • customWaterMarkId - adicione uma marca d'água personalizada a cada página do documento PDF
    • Padrão: vazio
  • quality - a qualidade do PDF retornado. O padrão usa a qualidade recomendada para um PDF.
    • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
    • Padrão: -1
    • Mínimo: -1
    • Máximo: 100
  • country - o país a captura de tela deve ser retirada.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • noAds - se for verdade anúncios devem ser ocultados automaticamente.
    • Padrão: false
  • noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
    • Padrão: false
  • address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio
  • mergeId - o ID de uma captura que deve ser mesclados no início do novo documento PDF
    • Padrão: vazio
  • password - a senha para proteger o documento PDF com
    • Padrão: vazio

Métodos públicos

  • add_post_parameter (nome, valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
    • name - o nome do parâmetro HTTP Post
    • value - o valor do parâmetro HTTP Post
  • add_template_parameter (nome, valor) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
    • nome - o nome do parâmetro do modelo
    • valor - o valor do parâmetro do modelo

url_to_docx(url, opções = nulo)

Especifica o URL que deve ser convertido into DOCX.

parâmetros

  • url - o URL que deve ser convertido into DOCX
    • Exigido
  • opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

html_to_docx(html, opções = nulo)

Especifica o HTML que deve ser convertido into DOCX.

parâmetros

  • html - o HTML para converter into DOCX
    • Exigido
  • opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

file_to_docx(caminho, opções = nulo)

Especifica um arquivo HTML que deve ser convertido into DOCX.

parâmetros

  • path - o caminho do arquivo HTML para converter into DOCX
    • Exigido
  • opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

DOCXOptions

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

Propriedades Públicas

  • customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
    • Padrão: vazio
  • includeBackground - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
    • Padrão: true
  • pagesize - o tamanho da página do DOCX
    • Padrão: "A4"
    • Opções: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Jurídico", "Carta"
  • orientation - a orientação do documento DOCX
    • Padrão: "Retrato"
    • Opções: "Retrato", "Paisagem"
  • includeLinks - true se os links devem ser incluídos no DOCX
    • Padrão: true
  • includeImages - se verdadeiro, as imagens da página da web devem ser incluídas no DOCX
    • Padrão: true
  • title - fornecer um título ao documento DOCX
    • Padrão: vazio
  • marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
    • Padrão: 10
  • marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
    • Padrão: 10
  • marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
    • Padrão: 10
  • marginRight - a margem em milímetros que deve aparecer à direita do documento DOCX
    • Padrão: 10
  • browserWidth - a largura do navegador em pixels
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: 1024
    • Máximo: 10000
    • Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento DOCX)
  • pageWidth - a largura personalizada do DOCX resultante em mm
  • pageHeight - a altura personalizada do DOCX resultante em mm
  • delay - o número de milissegundos a aguarde antes de tirar a captura de tela
    • Padrão: 0
    • Máximo: 30000
  • requestAs - o tipo de agente do usuário que você deseja usar
    • Padrão: 0
    • opções:
      • 0 = indica que o agente do usuário de um navegador padrão deve ser usado
      • 1 = indica que o agente do usuário de um navegador móvel deve ser usado
      • 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
  • templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
    • Padrão: vazio
  • targetElement - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into DOCX, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
    • Padrão: vazio
  • hideElement - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
    • Padrão: vazio
  • waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
    • Padrão: vazio
  • quality - a qualidade do DOCX devolvido. O padrão usa a qualidade recomendada para um DOCX.
    • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
    • Padrão: -1
    • Mínimo: -1
    • Máximo: 100
  • country - o país a captura de tela deve ser retirada.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • noAds - se for verdade anúncios devem ser ocultados automaticamente.
    • Padrão: false
  • noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
    • Padrão: false
  • address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio
  • mergeId - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
    • Padrão: vazio
  • password - a senha para proteger o documento DOCX com
    • Padrão: vazio

Métodos públicos

  • add_post_parameter (nome, valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
    • name - o nome do parâmetro HTTP Post
    • value - o valor do parâmetro HTTP Post
  • add_template_parameter (nome, valor) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
    • nome - o nome do parâmetro do modelo
    • valor - o valor do parâmetro do modelo

url_to_table(url, opções = nulo)

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

parâmetros

  • url - o URL para extrair tabelas HTML de
    • Exigido
  • opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

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

  • html - o HTML para extrair tabelas HTML.
    • Exigido
  • opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

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

  • path - o caminho do arquivo HTML para extrair as tabelas HTML.
    • Exigido
  • opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

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

  • customId - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou
    • Padrão: vazio
  • tableNumberToInclude - o índice da tabela a ser convertida, onde todas as tabelas em uma página da web são ordenadas da parte superior da página para a parte inferior
    • Padrão: 1
  • format - o formato em que a tabela deve estar
    • Padrão: "csv"
    • Opções: "csv", "json", "xlsx"
  • includeHeaderNames - se nomes de cabeçalho verdadeiros serão incluídos na tabela
    • Padrão: true
  • includeAllTables - se true, toda a tabela na página da Web será extraída, com cada tabela aparecendo em uma planilha separada. Disponível apenas no formato XLSX
    • Padrão: false
  • targetElement - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
    • Padrão: vazio
  • requestAs - o tipo de agente do usuário que você deseja usar
    • Padrão: 0
    • opções:
      • 0 = indica que o agente do usuário de um navegador padrão deve ser usado
      • 1 = indica que o agente do usuário de um navegador móvel deve ser usado
      • 2 = indica que o agente do usuário de um mecanismo de pesquisa deve ser usado
  • country - o país a captura de tela deve ser retirada.
    • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
    • Padrão: o local mais rápido atual
    • Opções: "SG", "Reino Unido", "EUA"
  • exportURL - a URL de exportação que especifica onde a captura também deve ser exportada
    • Padrão: vazio
  • encryptionKey - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
    • Padrão: vazio
  • address - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
    • Padrão: vazio
  • proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
    • Padrão: vazio

Métodos públicos

  • add_post_parameter (nome, valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
    • name - o nome do parâmetro HTTP Post
    • value - o valor do parâmetro HTTP Post

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

  • callBackURL - o treinador o serviço GrabzIt deve ligar depois de concluir seu trabalho

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

  • saveToArquivo - o caminho do arquivo que a captura será saved uma vez que tenha sido concluída
    • Exigido

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

  • id - o identificador exclusivo da captura de tela
    • Exigido

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

  • domínio - o domínio para o qual retornar cookies para
    • Exigido

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

  • nome - o nome do cookie a ser definido
    • Exigido
  • domínio - o domínio do site para definir o cookie para
    • Exigido
  • valor - o valor do cookie
  • path - o caminho do site ao qual o cookie está relacionado
  • httponly - se true, o cookie pode ser usado apenas com o protocolo HTTP
  • expira - define quando o cookie expira. Passe um valor nulo se o cookie não expirar
    • Deve estar no formato aaaa-mm-dd hh: mm: ss

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

  • nome - o nome do cookie a ser excluído
    • Exigido
  • domínio - o domínio do site para excluir o cookie para
    • Exigido

Valor de retorno

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


get_watermarks ()

Obtenha suas marcas d'água personalizadas enviadas

Valor de retorno

WaterMark ordem


get_watermark (identificador)

Obtenha suas marcas d'água personalizadas enviadas

parâmetros

  • identificador - o identificador de uma marca d'água personalizada específica que você deseja visualizar
    • Exigido

Valor de retorno

WaterMark


add_watermark (identificador, caminho, xpos, ypos)

Adicionar uma nova marca d'água personalizada

parâmetros

  • identificador - o identificador que você deseja dar à marca d'água personalizada. É importante que esse identificador seja único.
    • Exigido
  • path - o caminho absoluto da marca d'água no seu servidor. Por exemplo, C: /watermark/1.png
    • Exigido
  • xpos - a posição horizontal em que você deseja que a captura de tela apareça
    • Exigido
    • opções:
      • Esquerda = 0
      • Centro = 1
      • Direita = 2
  • ypos - posição vertical em que você deseja que a captura de tela apareça
    • Exigido
    • opções:
      • Topo = 0
      • Médio = 1
      • Parte inferior = 2

Valor de retorno

retorna true se a marca d'água foi definida com êxito


delete_watermark (identificador)

Excluir uma marca d'água personalizada

parâmetros

  • identificador - o identificador da marca d'água personalizada que você deseja excluir
    • Exigido

Valor de retorno

retorna true se a marca d'água foi excluída com sucesso


set_local_proxy (valor)

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

parâmetros

  • proxyUrl - a URL, que pode incluir uma porta, se necessário, do proxy. Fornecer um valor nulo removerá qualquer proxy definido anteriormente
    • Exigido

use_ssl (valor)

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

parâmetros

  • value - se true, todos os pedidos à API do GrabzIt usarão SSL
    • Exigido

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

  • name
    • O nome do cookie.
  • value
    • O valor do cookie.
  • domain
    • O domínio para o qual o cookie está definido.
  • path
    • O caminho no domínio ao qual este cookie se aplica.
  • httpOnly
    • Se este cookie for válido apenas quando o site for visualizado com o protocolo HTTP.
  • expires
    • A data em que esse cookie expira
  • type
    • O tipo de cookie é esse, que pode ser um dos seguintes:
      • Global - este é um cookie global definido por GrabzIt
      • Local - este é um cookie local definido por você
      • Substituído - um cookie global que foi substituído por você

ScreenShotStatus

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

Propriedades Públicas

  • processing
    • Se verdadeiro, a captura de tela ainda está sendo processada.
  • cached
    • Se verdadeiro, a captura de tela foi processada e está atualmente em cache.
  • expired
    • Se verdadeiro, a captura de tela não está mais no sistema GrabzIt.
  • message
    • Uma mensagem de erro retornada pelo sistema.

WaterMark

Esta classe representa as marcas d'água personalizadas armazenadas no GrabzIt

Propriedades Públicas

  • identifier
    • O identificador da marca d'água
  • xPosition
    • A posição horizontal da marca d'água
      • Esquerda = 0
      • Centro = 1
      • Direita = 2
  • yPosition
    • A posição vertical da marca d'água
      • Topo = 0
      • Médio = 1
      • Parte inferior = 2
  • format
    • O formato da marca d'água