Cliente GrabzIt com Python
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
- GetResult(id)
- URLToAnimation(url, options = None)
- URLToImage(url, options = None)
- HTMLToImage(html, options = None)
- FileToImage(path, options = None)
- URLToPDF(url, options = None)
- HTMLToPDF(html, options = None)
- FileToPDF(path, options = None)
- URLToDOCX(url, options = None)
- HTMLToDOCX(html, options = None)
- FileToDOCX(path, options = None)
- URLToTable(url, options = None)
- HTMLToTable(html, options = None)
- FileToTable(path, options = None)
- URLToRenderedHTML(url, options = None)
- HTMLToRenderedHTML(html, options = None)
- FileToRenderedHTML(path, options = None)
- Save(callBackURL = '')
- SaveTo()
- SaveTo(saveToFile)
- GetStatus(id)
- GetCookies(domain)
- SetCookie(name, domain, value = "", path = "/", httponly = False, expires = "")
- DeleteCookie(name, domain)
- GetWaterMarks()
- GetWaterMark(identifier)
- AddWaterMark(identifier, path, xpos, ypos)
- DeleteWaterMark(identifier)
- SetLocalProxy(proxyUrl)
- UseSSL(value)
- CreateEncryptionKey()
- Decrypt(path, key)
- DecryptFile(path, key)
GetResult(identidade)
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
Valor de retorno
A captura
URLToAnimation(url, opções = Nenhum)
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 GrabzItAnimationOptions classe que define todas as opções especiais a serem usadas ao criar o GIF animado.
Valor de retorno
anular
GrabzItAnimationOptions
A classe representa todas as opções disponíveis ao criar um GIF animado.
Atributos
-
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.
-
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.
-
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
- Nunca Loop: -1
-
reverse - se verdadeiro, os quadros do GIF animado são revertidos
-
customWaterMarkId - adicionar personalizado watermark para o GIF animado
-
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.
- 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
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
URLToImage(url, opções = Nenhum)
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
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar a captura de tela.
Valor de retorno
anular
HTMLToImage(html, opções = Nenhum)
Especifica o HTML que deve ser convertido intuma imagem.
parâmetros
-
html - o HTML para converter intoa imagem
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.
Valor de retorno
anular
FileToImage(caminho, opções = Nenhum)
Especifica um arquivo HTML que deve ser convertido intuma imagem.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa imagem
- opções - uma instância do GrabzItImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.
Valor de retorno
anular
GrabzItImageOptions
A classe representa todas as opções disponíveis ao criar capturas de imagens.
Atributos
-
customId - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
-
browserWidth - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
-
browserHeight - a altura do navegador em pixels
- Padrão: 1170
- 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: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final, se a altura de saída for especificada, a largura de saída será proporcional à altura de saída
- 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: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final; se a largura de saída for especificada, a altura de saída será proporcional à largura de saída
- 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
-
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
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
-
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
-
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
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 um personalizado watermark para a imagem
-
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.
-
hd - se verdadeira a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
-
country - o país a captura de tela deve ser retirada.
- 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
-
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.
-
noAds - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
De Depósito
-
AddPostParameter (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
URLToRenderedHTML(url, opções = Nenhum)
Especifica o URL que deve ser convertido into HTML renderizado.
parâmetros
-
url - a URL da qual o HTML renderizado deve ser feito
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar o HTML renderizado.
Valor de retorno
anular
HTMLToRenderedHTML(html, opções = Nenhum)
Especifica o HTML que deve ser convertido into HTML renderizado.
parâmetros
-
html - o HTML para converter into HTML renderizado
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.
Valor de retorno
anular
FileToRenderedHTML(caminho, opções = Nenhum)
Especifica um arquivo HTML que deve ser convertido into HTML renderizado.
parâmetros
-
path - o caminho do arquivo HTML para converter into HTML renderizado
- opções - uma instância do GrabzItHTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.
Valor de retorno
anular
GrabzItHTMLOptions
A classe representa todas as opções disponíveis quando criando capturas HTML renderizadas.
Atributos
-
customId - identificador personalizado que você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
-
browserWidth - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
-
browserHeight - a altura do navegador em pixels
- Padrão: 1170
- 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
-
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.
- 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
-
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.
-
noAds - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
De Depósito
-
AddPostParameter (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
URLToPDF(url, opções = Nenhum)
Especifica o URL que deve ser convertido intum PDF.
parâmetros
-
url - o URL que deve ser convertido intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
HTMLToPDF(html, opções = Nenhum)
Especifica o HTML que deve ser convertido intum PDF.
parâmetros
-
html - o HTML para converter intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
FileToPDF(caminho, opções = Nenhum)
Especifica um arquivo HTML que deve ser convertido intum PDF.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa PDF
- opções - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
Valor de retorno
anular
GrabzItPDFOptions
A classe representa todas as opções disponíveis ao criar capturas de PDF.
Atributos
-
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.
-
includeBackground - se verdadeiro, o plano de fundo da página da web deve ser incluído na captura de tela
-
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
-
includeOutline - verdadeiro se Favoritos em PDF Deveria ser incluído
-
title - forneça um título para o documento PDF
-
coverURL - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
-
marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
-
marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
-
marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
-
marginRight - a margem em milímetros que deve aparecer à direita do documento PDF
-
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: 1366
- 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
-
templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
-
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
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
-
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
-
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
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 um personalizado watermark para cada página do documento PDF
-
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.
- 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
-
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.
-
noAds - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
mergeId - o ID de uma captura que deve ser mesclados no início do novo documento PDF
-
password - a senha para proteger o documento PDF com
De Depósito
-
AddPostParameter (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
-
AddTemplateParameter (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
URLToDOCX (url, opções = Nenhum)
Especifica o URL que deve ser convertido into DOCX.
parâmetros
-
url - o URL que deve ser convertido into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
HTMLToDOCX(html, opções = Nenhum)
Especifica o HTML que deve ser convertido into DOCX.
parâmetros
-
html - o HTML para converter into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
FileToDOCX(caminho, opções = Nenhum)
Especifica um arquivo HTML que deve ser convertido into DOCX.
parâmetros
-
path - o caminho do arquivo HTML para converter into DOCX
- opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
Valor de retorno
anular
GrabzItDOCXOptions
A classe representa todas as opções disponíveis ao criar capturas de DOCX.
Atributos
-
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.
-
includeBackground - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
-
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
-
includeImages - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
-
title - fornecer um título ao documento DOCX
-
marginTop - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
-
marginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
-
marginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
-
marginRight - a margem em milímetros que deve aparecer à direita do documento DOCX
-
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: 1366
- 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
-
templateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
-
clickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
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
-
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
-
waitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
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
-
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.
- 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
-
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.
-
noAds - se for verdade anúncios devem ser ocultados automaticamente.
-
noCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
mergeId - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
-
password - a senha para proteger o documento DOCX com
De Depósito
-
AddPostParameter (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
-
AddTemplateParameter (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
URLToTable(url, opções = Nenhum)
Especifica a URL da qual as tabelas HTML devem ser extraídas.
parâmetros
-
url - o URL para extrair tabelas HTML de
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
HTMLToTable (html, opções = Nenhum)
Especifica o HTML do qual as tabelas HTML devem ser extraídas.
parâmetros
-
html - o HTML para extrair tabelas HTML.
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
FileToTable (caminho, opções = Nenhum)
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.
- opções - uma instância do GrabzItTableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
Valor de retorno
anular
GrabzItTableOptions
A classe representa todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.
Atributos
-
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
-
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
-
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
-
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
-
targetElement - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
-
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.
- 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
-
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.
-
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.
-
proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
De Depósito
-
AddPostParameter (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 = '')
Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o GetResult 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 GetResult método
Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado
SaveTo()
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
SaveTo(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
Valor de retorno
retorna true se for bem-sucedido, caso contrário, lança uma exceção.
GetStatus (id)
Obtenha o status atual de uma captura de tela do GrabzIt.
parâmetros
-
id - o identificador exclusivo da captura de tela
Valor de retorno
ScreenShotStatus objeto
GetCookies (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
Valor de retorno
GrabzItCookie ordem
SetCookie (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
-
domínio - o domínio do site para definir o cookie para
- 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 Nenhum 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
DeleteCookie (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
-
domínio - o domínio do site para excluir o cookie para
Valor de retorno
Verdadeiro se o cookie for excluído com êxito, caso contrário, falso
GetWaterMarks()
Obtenha seu personalizado enviado watermarks
Valor de retorno
GrabzItWaterMark ordem
GetWaterMark(identificador)
Devolva seu costume watermarks que corresponde ao identificador especificado
parâmetros
-
identificador - o identificador de um determinado costume watermark você quer ver
Valor de retorno
GrabzItWaterMark
AdicionarWaterMark(identificador, caminho, xpos, ypos)
Adicionar um novo personalizado watermark
parâmetros
-
identificador - o identificador que você deseja fornecer ao watermark. É importante que esse identificador seja único.
-
caminho - o caminho absoluto do watermark no seu servidor. Por exemplo C: /watermark/1.png
-
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 verdadeiro se o watermark foi definido com sucesso
DeleteWaterMark(identificador)
Excluir um personalizado watermark
parâmetros
-
identificador - o identificador do costume watermark você quer deletar
Valor de retorno
retorna verdadeiro se o watermark foi excluído com sucesso
SetLocalProxy (proxyUrl)
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
UseSSL (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
CreateEncryptionKey ()
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
DecryptFile (caminho, chave)
Descriptografe uma captura criptografada usando a chave de criptografia fornecida.
parâmetros
Classes de resultado
GrabzItCookie
Propriedades Públicas
-
Name
-
Value
-
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.
GrabzItWaterMark
Esta classe representa o costume watermarks armazenado no GrabzIt
Propriedades Públicas
-
Identifier
- O identificador do watermark
-
XPosition
-
A posição horizontal do watermark
- Esquerda = 0
- Centro = 1
- Direita = 2
-
YPosition
-
A posição vertical do watermark
- Topo = 0
- Médio = 1
- Parte inferior = 2
-
Format