Strumenti per acquisire e convertire il Web

Client GrabzIt con Ruby

API Ruby

Descrizione

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

Metodi pubblici

get_result (id)

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

parametri

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

Valore di ritorno

nulla

AnimationOptions

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

Proprietà pubbliche


url_to_image(Url, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

html_to_image(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into immagine.

parametri

Valore di ritorno

nulla

file_to_image(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into immagine.

parametri

Valore di ritorno

nulla

ImageOptions

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

Proprietà pubbliche

Metodi pubblici


url_to_rendered_html(Url, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

html_to_rendered_html(Html, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

file_to_rendered_html(sentiero, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

HTMLOptions

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

Proprietà pubbliche

Metodi pubblici


url_to_pdf(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into PDF.

parametri

Valore di ritorno

nulla

html_to_pdf(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into PDF.

parametri

Valore di ritorno

nulla

file_to_pdf(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into PDF.

parametri

Valore di ritorno

nulla

PDFOptions

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

Proprietà pubbliche

Metodi pubblici


url_to_docx(Url, Opzioni = zero)

Specifica l'URL che dovrebbe essere convertito into DOCX.

parametri

Valore di ritorno

nulla

html_to_docx(Html, Opzioni = zero)

Specifica l'HTML che dovrebbe essere convertito into DOCX.

parametri

Valore di ritorno

nulla

file_to_docx(sentiero, Opzioni = zero)

Specifica un file HTML che dovrebbe essere convertito into DOCX.

parametri

Valore di ritorno

nulla

DOCXOptions

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

Proprietà pubbliche

Metodi pubblici


url_to_table(Url, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

html_to_table(Html, Opzioni = zero)

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

parametri

Valore di ritorno

nulla

file_to_table(sentiero, Opzioni = zero)

Specifica un file HTML da cui estrarre le tabelle HTML.

parametri

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

Metodi pubblici


Questo è il metodo raccomandato per salvare un file

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

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


Avvertendo questo metodo è sincrono, quindi l'applicazione verrà messa in pausa mentre il risultato viene elaborato

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.


Avvertendo questo metodo è sincrono, quindi l'applicazione verrà messa in pausa mentre il risultato viene elaborato

save_to(saveToFile)

Save il risultato in modo sincrono in un file.

parametri

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

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

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

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

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

Valore di ritorno

WaterMark


Inserisci_watermark(identificatore, percorso, xpos, ypos)

Aggiungi una nuova personalizzazione watermark

parametri

Valore di ritorno

restituisce vero se il watermark è stato impostato con successo


Elimina_watermark(Identificatore)

Elimina un'abitudine watermark

parametri

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


use_ssl (valore)

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

parametri


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


decrypt_file (percorso, chiave)

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

parametri


Classi di risultati

Cookie

Proprietà pubbliche

ScreenShotStatus

La classe che rappresenta lo stato corrente dello screenshot.

Proprietà pubbliche

WaterMark

Questa classe rappresenta l'usanza watermarks archiviato in GrabzIt

Proprietà pubbliche