Client GrabzIt con Ruby

Descrizione

Questa classe gestisce tutte le comunicazioni con i servizi web di screenshot di GrabzIt.

Metodi pubblici

• get_result(id)
• url_to_animation(url, options = nil)
• url_to_image(url, options = nil)
• html_to_image(html, options = nil)
• file_to_image(path, options = nil)
• url_to_pdf(url, options = nil)
• html_to_pdf(html, options = nil)
• file_to_pdf(path, options = nil)
• url_to_docx(url, options = nil)
• html_to_docx(html, options = nil)
• file_to_docx(path, options = nil)
• url_to_table(url, options = nil)
• html_to_table(html, options = nil)
• file_to_table(path, options = nil)
• url_to_rendered_html(url, options = nil)
• html_to_rendered_html(html, options = nil)
• file_to_rendered_html(path, options = nil)
• save(callBackURL = nil)
• save_to()
• save_to(saveToFile)
• get_status(id)
• get_cookies(domain)
• set_cookie(name, domain, value = "", path = "/", httponly = false, expires = "")
• delete_cookie(name, domain)
• get_watermarks()
• get_watermark(identifier)
• add_watermark(identifier, path, xpos, ypos)
• delete_watermark(identifier)
• set_local_proxy(value)
• use_ssl(value)
• create_encryption_key()
• decrypt(path, key)
• decrypt_file(path, key)

get_result (id)

Questo metodo restituisce lo screenshot stesso. Se non viene restituito nulla, qualcosa è andato storto o lo screenshot non è ancora pronto.

parametri

• id - l'identificatore univoco dello screenshot
  • Obbligatorio

Valore di ritorno

La cattura

url_to_animation(Url, Opzioni = zero)

Specifica l'URL del video online che dovrebbe essere convertito into GIF animata.

parametri

• url: l'URL del video online da convertire into una GIF animata.
  • Obbligatorio
  • Accetta URL video di Vimeo e YouTube
    • L'avvertimento dell'animazione di video Vimeo e YouTube dipende da una terza parte e pertanto potrebbe non fornire risultati coerenti.
• Opzioni - un'istanza di AnimationOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione della GIF animata.

Valore di ritorno

nulla

AnimationOptions

La classe rappresenta tutte le opzioni disponibili durante la creazione di una GIF animata.

Proprietà pubbliche

• customId - identificativo personalizzato che è possibile passare al servizio web GIF animato. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• width - la larghezza della GIF animata risultante in pixel.
  • Predefinito: 180px
  • Massima: larghezza massima per pacchetto
  • Dimensione automatica: -1 (passando -1 significa che la larghezza di la GIF animata viene ridimensionata in relazione alla sua altezza, se la larghezza viene ridimensionata automaticamente, l'altezza non può)
• height - l'altezza della GIF animata risultante in pixel.
  • Predefinito: 120px
  • Massimo: altezza massima per pacchetto
  • Dimensione automatica: -1 (passando -1 significa che l'altezza di la GIF animata viene ridimensionata in relazione alla sua larghezza, se l'altezza viene ridimensionata automaticamente la larghezza non può)
• start - la posizione iniziale del video che dovrebbe essere convertito into GIF animata.
  • Predefinito: 0 secondi
• duration - la lunghezza in secondi del video che dovrebbe essere convertito into GIF animata.
  • Predefinito: lunghezza massima per il pacchetto
• speed - la velocità della GIF animata.
  • Predefinito: 1
  • Minimo: 0.2
  • Massimo: 10
• framesPerSecond - il numero di fotogrammi al secondo che devono essere acquisiti dal video.
  • Predefinito: 10
  • Minimo: 0.2
  • Massimo: 60
• repeat - numero di volte per eseguire il ciclo della GIF animata.
  • Predefinito: 0
  • Ciclo continuo: 0
• reverse - se vero, i frame della GIF animata sono invertiti
  • Predefinito: falso
• customWaterMarkId - aggiungi personalizzato watermark alla GIF animata
  • Predefinito: vuoto
• quality - il qualità dell'immagine restituita, che ha una compressione predefinita di 85%.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• country - Paese la GIF animata dovrebbe essere presa da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

url_to_image(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into uno screenshot di immagine.

parametri

• url: l'URL di cui dovrebbe essere fatto lo screenshot
  • Obbligatorio
• Opzioni - un'istanza di ImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dello screenshot.

Valore di ritorno

nulla

html_to_image(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into immagine.

parametri

• html - l'HTML da convertire into immagine
  • Obbligatorio
• Opzioni - un'istanza di ImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un'immagine.

Valore di ritorno

nulla

file_to_image(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into immagine.

parametri

• percorso: il percorso del file di un file HTML da convertire into immagine
  • Obbligatorio
• Opzioni - un'istanza di ImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un'immagine.

Valore di ritorno

nulla

ImageOptions

La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni di immagini.

Proprietà pubbliche

• customId - identificativo personalizzato che è possibile passare al servizio web screenshot. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• browserWidth - la larghezza del browser in pixel
  • Predefinito: 1024
  • Massimo: 10000
• browserHeight - l'altezza del browser in pixel
  • Predefinito: 768
  • Massimo: 10000
  • Lunghezza totale: -1 (passando -1 significa che viene presa una sequenza dell'intera pagina Web)
• width - la larghezza della miniatura risultante in pixel
  • Predefinito: il rapporto più alto possibile tra la larghezza del browser e la larghezza massima per il pacchetto degli utenti
  • Massima: larghezza massima per pacchetto
  • Larghezza intera: -1 (passando -1 significa che la larghezza della miniatura non viene ridotta)
• height - l'altezza della miniatura risultante in pixel
  • Predefinito: il rapporto più alto possibile dell'altezza del browser che si adatta all'altezza massima per il pacchetto degli utenti
  • Massimo: altezza massima per pacchetto
  • Altezza totale: -1 (passando -1 significa che l'altezza della miniatura non viene ridotta)
• format - il formato in cui dovrebbe essere lo screenshot.
  • Predefinito: "jpg"
  • Opzioni: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
• delay - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• targetElement - il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into screenshot, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
  • Predefinito: vuoto
• hideElement - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
  • Predefinito: vuoto
• waitForElement - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• requestAs - il tipo di agente utente che si desidera utilizzare
  • Predefinito: 0
  • Opzioni:
    • 0 = indica che deve essere utilizzato l'agente utente di un browser standard
    • 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
    • 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
• customWaterMarkId - aggiungi una personalizzazione watermark all'immagine
  • Predefinito: vuoto
• quality - il qualità dell'immagine restituita. Questo attualmente ha effetto solo sulle immagini JPG e WEBP, che hanno una compressione predefinita del 90%.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• transparent - se vero il l'acquisizione delle immagini dovrebbe essere trasparente. Questo è compatibile solo con immagini png e tiff.
  • Predefinito: falso
• hd - se vera l'immagine la cattura sarà in alta definizione questo raddoppia la dimensione delle dimensioni dell'immagine.
  • Predefinito: falso
• country - Paese lo screenshot dovrebbe essere preso da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• noAds - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• noCookieNotifications - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• address - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• add_post_parameter (nome, valore) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
  • name - il nome del parametro HTTP Post
  • valore - il valore del parametro HTTP Post

url_to_rendered_html(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into rendering HTML.

parametri

• url: l'URL di cui deve essere composto l'HTML renderizzato
  • Obbligatorio
• Opzioni - un'istanza di HTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dell'HTML renderizzato.

Valore di ritorno

nulla

html_to_rendered_html(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into rendering HTML.

parametri

• html - l'HTML da convertire into rendering HTML
  • Obbligatorio
• Opzioni - un'istanza di HTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di HTML renderizzato.

Valore di ritorno

nulla

file_to_rendered_html(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into rendering HTML.

parametri

• percorso: il percorso del file di un file HTML da convertire into rendering HTML
  • Obbligatorio
• Opzioni - un'istanza di HTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di HTML renderizzato.

Valore di ritorno

nulla

HTMLOptions

La classe rappresenta tutte le opzioni disponibili quando creazione di acquisizioni HTML renderizzate.

Proprietà pubbliche

• customId - identificativo personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• browserWidth - la larghezza del browser in pixel
  • Predefinito: 1024
  • Massimo: 10000
• browserHeight - l'altezza del browser in pixel
  • Predefinito: 768
  • Massimo: 10000
• waitForElement - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• requestAs - il tipo di agente utente che si desidera utilizzare
  • Predefinito: 0
  • Opzioni:
    • 0 = indica che deve essere utilizzato l'agente utente di un browser standard
    • 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
    • 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
• country - Paese lo screenshot dovrebbe essere preso da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• noAds - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• noCookieNotifications - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• address - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• add_post_parameter (nome, valore) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
  • name - il nome del parametro HTTP Post
  • valore - il valore del parametro HTTP Post

url_to_pdf(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into PDF.

parametri

• url: l'URL che deve essere convertito into PDF
  • Obbligatorio
• Opzioni - un'istanza della classe PDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.

Valore di ritorno

nulla

html_to_pdf(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into PDF.

parametri

• html - l'HTML da convertire into PDF
  • Obbligatorio
• Opzioni - un'istanza della classe PDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.

Valore di ritorno

nulla

file_to_pdf(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into PDF.

parametri

• percorso: il percorso del file di un file HTML da convertire into PDF
  • Obbligatorio
• Opzioni - un'istanza della classe PDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.

Valore di ritorno

nulla

PDFOptions

La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni PDF.

Proprietà pubbliche

• customId - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• includeBackground - se vero, lo sfondo della pagina Web deve essere incluso nello screenshot
  • Predefinito: vero
• pagesize - le dimensioni della pagina del PDF
  • Predefinito: "A4"
  • Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
• orientation - l'orientamento del documento PDF
  • Predefinito: "Ritratto"
  • Opzioni: "Ritratto", "Paesaggio"
• cssMediaType - il Tipo di supporto CSS del documento PDF
  • Predefinito: "Schermo"
  • Opzioni: "Schermo", "Print"
• includeLinks - vero se i collegamenti devono essere inclusi nel PDF
  • Predefinito: vero
• includeOutline - vero se Segnalibri PDF dovrebbe essere incluso
  • Predefinito: falso
• title - fornire un titolo al documento PDF
  • Predefinito: vuoto
• coverURL - l'URL di una pagina Web che dovrebbe essere utilizzata come copertina per il PDF
  • Predefinito: vuoto
• marginTop - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento PDF
  • Predefinito: 10
• marginLeft - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento PDF
  • Predefinito: 10
• marginBottom - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento PDF
  • Predefinito: 10
• marginRight - il margine in millimetri che dovrebbe apparire alla destra del documento PDF
  • Predefinito: 10
• browserWidth - il larghezza del browser in pixel
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: 1024
  • Massimo: 10000
  • Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento PDF)
• pageWidth - il larghezza personalizzata del PDF risultante in mm
  • Predefinito: dimensioni della pagina larghezza
  • Minimo: 15
• pageHeight - il altezza personalizzata del PDF risultante in mm
  • Predefinito: dimensioni della pagina altezza
  • Minimo: 15
• delay - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• requestAs - il tipo di agente utente che si desidera utilizzare
  • Predefinito: 0
  • Opzioni:
    • 0 = indica che deve essere utilizzato l'agente utente di un browser standard
    • 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
    • 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
• templateId - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento PDF
  • Predefinito: vuoto
• targetElement - il Selettore CSS dell'unico Elemento HTML sulla pagina Web di destinazione che deve essere trasformato into PDF, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
  • Predefinito: vuoto
• hideElement - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
  • Predefinito: vuoto
• waitForElement - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• customWaterMarkId - aggiungi una personalizzazione watermark a ciascuna pagina del documento PDF
  • Predefinito: vuoto
• quality - il qualità del PDF restituito. L'impostazione predefinita utilizza la qualità consigliata per un PDF.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• country - Paese lo screenshot dovrebbe essere preso da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• noAds - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• noCookieNotifications - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• address - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto
• mergeId - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento PDF
  • Predefinito: vuoto
• password - il password per proteggere il documento PDF
  • Predefinito: vuoto

Metodi pubblici

• add_post_parameter (nome, valore) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
  • name - il nome del parametro HTTP Post
  • valore - il valore del parametro HTTP Post
• add_template_parameter (nome, valore) - definire a modello personalizzato parametro e valore, questo metodo può essere chiamato più volte per aggiungere più parametri.
  • name - il nome del parametro template
  • value - il valore del parametro template

url_to_docx(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into DOCX.

parametri

• url: l'URL che deve essere convertito into DOCX
  • Obbligatorio
• Opzioni - un'istanza di DOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.

Valore di ritorno

nulla

html_to_docx(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into DOCX.

parametri

• html - l'HTML da convertire into DOCX
  • Obbligatorio
• Opzioni - un'istanza di DOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.

Valore di ritorno

nulla

file_to_docx(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into DOCX.

parametri

• percorso: il percorso del file di un file HTML da convertire into DOCX
  • Obbligatorio
• Opzioni - un'istanza di DOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.

Valore di ritorno

nulla

DOCXOptions

La classe rappresenta tutte le opzioni disponibili durante la creazione di acquisizioni DOCX.

Proprietà pubbliche

• customId - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• includeBackground - se vero, le immagini di sfondo della pagina Web devono essere incluse nel DOCX
  • Predefinito: vero
• pagesize - le dimensioni della pagina del DOCX
  • Predefinito: "A4"
  • Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
• orientation - l'orientamento del documento DOCX
  • Predefinito: "Ritratto"
  • Opzioni: "Ritratto", "Paesaggio"
• includeLinks - true se i collegamenti devono essere inclusi nel DOCX
  • Predefinito: vero
• includeImages - se vero, le immagini della pagina Web devono essere incluse nel DOCX
  • Predefinito: vero
• title - fornire un titolo al documento DOCX
  • Predefinito: vuoto
• marginTop - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento DOCX
  • Predefinito: 10
• marginLeft - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento DOCX
  • Predefinito: 10
• marginBottom - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento DOCX
  • Predefinito: 10
• marginRight - il margine in millimetri che dovrebbe apparire alla destra del documento DOCX
  • Predefinito: 10
• browserWidth - il larghezza del browser in pixel
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: 1024
  • Massimo: 10000
  • Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento DOCX)
• pageWidth - il larghezza personalizzata del DOCX risultante in mm
  • Predefinito: dimensioni della pagina larghezza
  • Minimo: 15
• pageHeight - il altezza personalizzata del DOCX risultante in mm
  • Predefinito: dimensioni della pagina altezza
  • Minimo: 15
• delay - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• requestAs - il tipo di agente utente che si desidera utilizzare
  • Predefinito: 0
  • Opzioni:
    • 0 = indica che deve essere utilizzato l'agente utente di un browser standard
    • 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
    • 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
• templateId - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento DOCX
  • Predefinito: vuoto
• targetElement - il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into DOCX, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo
  • Predefinito: vuoto
• hideElement - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola
  • Predefinito: vuoto
• waitForElement - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• quality - il qualità del DOCX restituito. L'impostazione predefinita utilizza la qualità consigliata per un DOCX.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• country - Paese lo screenshot dovrebbe essere preso da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• noAds - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• noCookieNotifications - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• address - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto
• mergeId - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento DOCX
  • Predefinito: vuoto
• password - il password per proteggere il documento DOCX
  • Predefinito: vuoto

Metodi pubblici

• add_post_parameter (nome, valore) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
  • name - il nome del parametro HTTP Post
  • valore - il valore del parametro HTTP Post
• add_template_parameter (nome, valore) - definire a modello personalizzato parametro e valore, questo metodo può essere chiamato più volte per aggiungere più parametri.
  • name - il nome del parametro template
  • value - il valore del parametro template

url_to_table(Url, Opzioni = zero)

Specifica l'URL da cui devono essere estratte le tabelle HTML.

parametri

• url - l'URL da cui estrarre le tabelle HTML
  • Obbligatorio
• Opzioni - un'istanza di TableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

html_to_table(Html, Opzioni = zero)

Specifica l'HTML da cui devono essere estratte le tabelle HTML.

parametri

• html - l'HTML da cui estrarre le tabelle HTML.
  • Obbligatorio
• Opzioni - un'istanza di TableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

file_to_table(sentiero, Opzioni = zero)

Specifica un file HTML da cui estrarre le tabelle HTML.

parametri

• percorso: il percorso del file di un file HTML da cui estrarre le tabelle HTML.
  • Obbligatorio
• Opzioni - un'istanza di TableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

TableOptions

La classe rappresenta tutte le opzioni disponibili durante la conversione di tabelle HTML in CSV, XLSX o JSON.

Proprietà pubbliche

• customId - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato
  • Predefinito: vuoto
• tableNumberToInclude - l'indice della tabella da convertire, dove tutte le tabelle di una pagina Web sono ordinate dalla parte superiore della pagina Web verso il basso
  • Predefinito: 1
• format - il formato in cui deve essere la tabella
  • Predefinito: "csv"
  • Opzioni: "csv", "json", "xlsx"
• includeHeaderNames - se nella tabella saranno inclusi i nomi di intestazioni vere
  • Predefinito: vero
• includeAllTables - se vero, tutta la tabella della pagina Web verrà estratta con ciascuna tabella visualizzata in un foglio di calcolo separato. Disponibile solo con il formato XLSX
  • Predefinito: falso
• targetElement - l'id dell'unico elemento HTML nella pagina Web da cui utilizzare per estrarre le tabelle
  • Predefinito: vuoto
• requestAs - il tipo di agente utente che si desidera utilizzare
  • Predefinito: 0
  • Opzioni:
    • 0 = indica che deve essere utilizzato l'agente utente di un browser standard
    • 1 = indica che deve essere utilizzato l'agente utente di un browser mobile
    • 2 = indica che deve essere utilizzato l'agente utente di un motore di ricerca
• country - Paese lo screenshot dovrebbe essere preso da.
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: "SG", "UK", "US"
• exportURL - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• encryptionKey - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Si consiglia di utilizzare il creare il metodo della chiave di crittografia per creare la chiave e il decodificare i metodi per decrittografare l'acquisizione crittografata come mostrato in questo esempio.
  • Predefinito: vuoto
• address - l'URL in cui eseguire il codice HTML. Può essere utile se viene utilizzato l'HTML da convertire URL relativi per risorse come CSS e immagini.
  • Predefinito: vuoto
• proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• add_post_parameter (nome, valore) - definisce un parametro HTTP Post e facoltativamente valore, questo metodo può essere chiamato più volte per aggiungere più parametri. L'uso di questo metodo forzerà GrabzIt a eseguire un post HTTP.
  • name - il nome del parametro HTTP Post
  • valore - il valore del parametro HTTP Post

save(callBackURL = zero)

Save il risultato in modo asincrono e restituisce un identificatore univoco, che può essere utilizzato per ottenere lo screenshot con il get_result metodo.

parametri

• callBackURL - il Handler il servizio GrabzIt dovrebbe chiamare dopo aver completato il suo lavoro

Valore di ritorno

L'identificatore univoco dello screenshot, altrimenti in caso di errore viene generata un'eccezione. Questo può essere usato per ottenere lo screenshot con il metodo get_result

save_to()

Save il risultato in modo sincrono con una variabile contenente i dati del byte dello screenshot.

Valore di ritorno

restituisce i dati byte del file in caso di successo, altrimenti genera un'eccezione.

save_to(saveToFile)

Save il risultato in modo sincrono in un file.

parametri

• saveToFile: il percorso del file che verrà acquisito sarà saveda una volta che è stato completato
  • Obbligatorio

Valore di ritorno

restituisce il vero se ha esito positivo, altrimenti genera un'eccezione.

get_status(Id)

Ottieni lo stato corrente di uno screenshot di GrabzIt.

parametri

• id - l'identificatore univoco dello screenshot
  • Obbligatorio

Valore di ritorno

ScreenShotStatus oggetto

get_cookies(dominio)

Ricevi tutti i cookie che GrabzIt utilizza per un determinato dominio. Ciò può includere anche i cookie definiti dall'utente.

parametri

• dominio - il dominio per cui restituire i cookie
  • Obbligatorio

Valore di ritorno

Cookie schieramento

set_cookie (nome, dominio, valore = "", percorso = "/", httponly = false, expires = "")

Imposta un nuovo cookie personalizzato su GrabzIt, se il cookie personalizzato ha lo stesso nome e dominio di un cookie globale, il cookie globale viene sovrascritto.

Ciò può essere utile se la funzionalità di un sito Web è controllata dai cookie.

parametri

• nome: il nome del cookie da impostare
  • Obbligatorio
• dominio - il dominio del sito Web per cui impostare il cookie
  • Obbligatorio
• valore - il valore del cookie
• percorso: il percorso del sito Web a cui si riferisce il cookie
• httponly - se vero, il cookie può essere utilizzato solo con il protocollo HTTP
• scade: definisce quando scade il cookie. Passa un valore zero se il cookie non deve scadere
  • Dovrebbe essere nel formato aaaa-mm-gg hh: mm: ss

Valore di ritorno

Vero se il cookie è impostato correttamente, altrimenti falso

delete_cookie (nome, dominio)

Elimina un cookie personalizzato o blocca l'utilizzo di un cookie globale

parametri

• nome: il nome del cookie da eliminare
  • Obbligatorio
• dominio - il dominio del sito Web per cui eliminare il cookie
  • Obbligatorio

Valore di ritorno

Vero se il cookie viene eliminato correttamente, altrimenti falso

ottenere_watermarks()

Ottieni il tuo personalizzato caricato watermarks

Valore di ritorno

WaterMark schieramento

ottenere_watermark(Identificatore)

Ottieni il tuo personalizzato caricato watermarks

parametri

• identificatore: l'identificatore di una particolare consuetudine watermark si desidera visualizzare
  • Obbligatorio

Valore di ritorno

WaterMark

Inserisci_watermark(identificatore, percorso, xpos, ypos)

Aggiungi una nuova personalizzazione watermark

parametri

• identificatore: l'identificatore che desideri assegnare alla personalizzazione watermark. È importante che questo identificatore sia univoco.
  • Obbligatorio
• path - il percorso assoluto di watermark sul tuo server. Ad esempio C: /watermark/1.png
  • Obbligatorio
• xpos - la posizione orizzontale in cui vuoi che appaia lo screenshot
  • Obbligatorio
  • Opzioni:
    • Sinistra = 0
    • Centro = 1
    • Destra = 2
• ypos - posizione verticale in cui vuoi che appaia lo screenshot
  • Obbligatorio
  • Opzioni:
    • Superiore = 0
    • Medio = 1
    • In basso = 2

Valore di ritorno

restituisce vero se il watermark è stato impostato con successo

Elimina_watermark(Identificatore)

Elimina un'abitudine watermark

parametri

• identificatore: l'identificatore dell'abitudine watermark si desidera eliminare
  • Obbligatorio

Valore di ritorno

restituisce vero se il watermark è stato cancellato con successo

set_local_proxy (valore)

Questo metodo consente a server proxy locale da utilizzare per tutte le richieste.

parametri

• proxyUrl: l'URL, che può includere una porta, se necessario, del proxy. Fornire un valore null rimuoverà qualsiasi proxy precedentemente impostato
  • Obbligatorio

use_ssl (valore)

Specifica se le richieste a GrabzIt's L'API dovrebbe usare SSL

parametri

• valore - se vero tutte le richieste all'API di GrabzIt utilizzeranno SSL
  • Obbligatorio

create_encryption_key ()

Crea una chiave di crittografia 64 di base crittograficamente sicura, lunga 44 caratteri.

decifrare (dati, chiave)

Decifrare un'acquisizione crittografata utilizzando la chiave di crittografia fornita.

parametri

• dati: i byte crittografati
  • Obbligatorio
• chiave - il chiave di crittografia
  • Obbligatorio

decrypt_file (percorso, chiave)

Decifrare un'acquisizione crittografata utilizzando la chiave di crittografia fornita.

parametri

• percorso: il percorso dell'acquisizione crittografata
  • Obbligatorio
• chiave - il chiave di crittografia
  • Obbligatorio

Classi di risultati

Cookie

Proprietà pubbliche

• name
  • Il nome del cookie
• value
  • Il valore del cookie
• domain
  • Il dominio per cui è impostato il cookie.
• path
  • Il percorso sul dominio a cui si applica questo cookie.
• httpOnly
  • Se questo cookie è valido solo quando il sito Web viene visualizzato con il protocollo HTTP.
• expires
  • La data di scadenza di questo cookie
• type
  • Questo è il tipo di cookie, che può essere uno dei seguenti:
    • Globale: questo è un cookie globale impostato da GrabzIt
    • Locale: questo è un cookie locale impostato da te
    • Sostituito: un cookie globale che è stato sovrascritto da te

ScreenShotStatus

La classe che rappresenta lo stato corrente dello screenshot.

Proprietà pubbliche

• processing
  • Se vero, lo screenshot è ancora in fase di elaborazione.
• cached
  • Se vero, lo screenshot è stato elaborato ed è attualmente memorizzato nella cache.
• expired
  • Se vero, lo screenshot non è più sul sistema GrabzIt.
• message
  • Un messaggio di errore restituito dal sistema.

WaterMark

Questa classe rappresenta l'usanza watermarks archiviato in GrabzIt

Proprietà pubbliche

• identifier
  • L'identificatore del file watermark
• xPosition
  • La posizione orizzontale del watermark
    • Sinistra = 0
    • Centro = 1
    • Destra = 2
• yPosition
  • La posizione verticale del watermark
    • Superiore = 0
    • Medio = 1
    • In basso = 2
• format
  • Il formato del file watermark