Strumenti per acquisire e convertire il Web

Cliente con PerlAPI Perl

Descrizione

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

Metodi pubblici

GetResult($ 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


URLToAnimation($ Url, $ options)

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 del GrabzItAnimationOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione della GIF animata.

Valore di ritorno

nulla

GrabzItAnimationOptions

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

Proprietà pubbliche

  • customId($value) - identificativo personalizzato che è possibile passare al servizio web GIF animato. Questo verrà restituito con l'URL di callback che hai specificato.
    • Predefinito: vuoto
  • width($value) - 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($value) - 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($value) - la posizione iniziale del video che dovrebbe essere convertito into GIF animata.
    • Predefinito: 0 secondi
  • duration($value) - la lunghezza in secondi del video che dovrebbe essere convertito into GIF animata.
    • Predefinito: lunghezza massima per il pacchetto
  • speed($value) - la velocità della GIF animata.
    • Predefinito: 1
    • Minimo: 0.2
    • Massimo: 10
  • framesPerSecond($value) - il numero di fotogrammi al secondo che devono essere acquisiti dal video.
    • Predefinito: 10
    • Minimo: 0.2
    • Massimo: 60
  • repeat($value) - numero di volte per eseguire il ciclo della GIF animata.
    • Predefinito: 0
    • Ciclo continuo: 0
  • reverse($value) - se 1 i frame della GIF animata sono invertiti
    • Predefinito: 0
  • customWaterMarkId($value) - aggiungi filigrana personalizzata alla GIF animata
    • Predefinito: vuoto
  • quality($value) - 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($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Poiché Perl ha scarse funzionalità di crittografia nativa, è necessario segui queste istruzioni per decrittografare un'acquisizione crittografata.
    • Predefinito: vuoto
  • proxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto

URLToImage($ Url, $ options)

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 del GrabzItImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dello screenshot.

Valore di ritorno

nulla

HTMLToImage($ Html, $ options)

Specifica l'HTML che dovrebbe essere convertito into immagine.

parametri

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

Valore di ritorno

nulla

FileToImage($ Path, $ options)

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 del GrabzItImageOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un'immagine.

Valore di ritorno

nulla

GrabzItImageOptions

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

Proprietà pubbliche

  • customId($value) - identificativo personalizzato che è possibile passare al servizio web screenshot. Questo verrà restituito con l'URL di callback che hai specificato.
    • Predefinito: vuoto
  • browserWidth($value) - la larghezza del browser in pixel
    • Predefinito: 1024
    • Massimo: 10000
  • browserHeight($value) - 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($value) - 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($value) - 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($value) - il formato in cui dovrebbe essere lo screenshot.
    • Predefinito: "jpg"
    • Opzioni: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
  • delay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
    • Predefinito: 0
    • Massimo: 30000
  • targetElement($value) - 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($value) - 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($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
    • Predefinito: vuoto
  • requestAs($value) - 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
      • 3 = indica che deve essere utilizzato l'agente utente di un browser di base
  • customWaterMarkId($value) - aggiungi una filigrana personalizzata all'immagine
    • Predefinito: vuoto
  • quality($value) - il qualità dell'immagine restituita. Questo attualmente ha effetto solo sulle immagini JPG, 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
  • transparent($value) - se 1 il l'acquisizione delle immagini dovrebbe essere trasparente. Questo è compatibile solo con immagini png e tiff.
    • Predefinito: 0
  • hd($value) - se 1 l'immagine la cattura sarà in alta definizione questo raddoppia la dimensione delle dimensioni dell'immagine.
    • Predefinito: 0
  • country($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Poiché Perl ha scarse funzionalità di crittografia nativa, è necessario segui queste istruzioni per decrittografare un'acquisizione crittografata.
    • Predefinito: vuoto
  • noAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • noCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • address($value) - l'URL in cui eseguire il codice HTML. Può essere utile se l'HTML da convertire utilizza URL relativi a risorse come CSS e immagini.
    • Predefinito: vuoto
  • proxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto

Metodi pubblici

  • AddPostParameter ($ name, $ value) - 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

URLToRenderedHTML($ Url, $ options = null)

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 del GrabzItHTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione dell'HTML renderizzato.

Valore di ritorno

nulla

HTMLToRenderedHTML($ Html, $ options = null)

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

parametri

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

Valore di ritorno

nulla

FileToRenderedHTML($ Path, $ options = null)

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 del GrabzItHTMLOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di HTML renderizzato.

Valore di ritorno

nulla

GrabzItHTMLOptions

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

Proprietà pubbliche

  • customId($value) - identificativo personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
    • Predefinito: vuoto
  • browserWidth($value) - la larghezza del browser in pixel
    • Predefinito: 1024
    • Massimo: 10000
  • browserHeight($value) - l'altezza del browser in pixel
    • Predefinito: 768
    • Massimo: 10000
  • delay($value) - il numero di millisecondi a attendere prima di effettuare la cattura
    • Predefinito: 0
    • Massimo: 30000
  • waitForElement($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
    • Predefinito: vuoto
  • requestAs($value) - 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
      • 3 = indica che deve essere utilizzato l'agente utente di un browser di base
  • country($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - 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($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • noCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • address($value) - 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($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto

Metodi pubblici

  • AddPostParameter ($ name, $ value) - 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

URLToPDF($ Url, $ options)

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 GrabzItPDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.

Valore di ritorno

nulla

HTMLToPDF($ Html, $ options)

Specifica l'HTML che dovrebbe essere convertito into PDF.

parametri

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

Valore di ritorno

nulla

FileToPDF($ Path, $ options)

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 GrabzItPDFOptions che definisce eventuali opzioni speciali da utilizzare durante la creazione di un PDF.

Valore di ritorno

nulla

GrabzItPDFOptions

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

Proprietà pubbliche

  • customId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
    • Predefinito: vuoto
  • includeBackground($value) - se 1 lo sfondo della pagina Web deve essere incluso nel PDF
    • Predefinito: 1
  • pagesize($value) - le dimensioni della pagina del PDF
    • Predefinito: "A4"
    • Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
  • orientation($value) - l'orientamento del documento PDF
    • Predefinito: "Ritratto"
    • Opzioni: "Ritratto", "Paesaggio"
  • cssMediaType($value) - il Tipo di supporto CSS del documento PDF
    • Predefinito: "Schermo"
    • Opzioni: "Schermo", "Print"
  • includeLinks($value) - 1 se i collegamenti devono essere inclusi nel PDF
    • Predefinito: 1
  • includeOutline($value) - 1 se Segnalibri PDF dovrebbe essere incluso
    • Predefinito: 0
  • title($value) - fornire un titolo al documento PDF
    • Predefinito: vuoto
  • coverURL($value) - l'URL di una pagina Web che dovrebbe essere utilizzata come copertina per il PDF
    • Predefinito: vuoto
  • marginTop($value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento PDF
    • Predefinito: 10
  • marginLeft($value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento PDF
    • Predefinito: 10
  • marginBottom($value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento PDF
    • Predefinito: 10
  • marginRight($value) - il margine in millimetri che dovrebbe apparire alla destra del documento PDF
    • Predefinito: 10
  • browserWidth($value) - 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
  • pageHeight - il altezza personalizzata del PDF risultante in mm
  • delay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
    • Predefinito: 0
    • Massimo: 30000
  • requestAs($value) - 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
      • 3 = indica che deve essere utilizzato l'agente utente di un browser di base
  • templateId($value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento PDF
    • Predefinito: vuoto
  • targetElement($value) - 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($value) - 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($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
    • Predefinito: vuoto
  • customWaterMarkId($value) - aggiungi una filigrana personalizzata a ciascuna pagina del documento PDF
    • Predefinito: vuoto
  • quality($value) - 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($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Poiché Perl ha scarse funzionalità di crittografia nativa, è necessario segui queste istruzioni per decrittografare un'acquisizione crittografata.
    • Predefinito: vuoto
  • noAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • noCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • address($value) - l'URL in cui eseguire il codice HTML. Può essere utile se l'HTML da convertire utilizza URL relativi a risorse come CSS e immagini.
    • Predefinito: vuoto
  • proxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto
  • mergeId($value) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento PDF
    • Predefinito: vuoto
  • password($value) - il password per proteggere il documento PDF con i
    • Predefinito: vuoto

Metodi pubblici

  • AddPostParameter ($ name, $ value) - 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
  • AddTemplateParameter ($ name, $ value) - 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

URLToDOCX ($ url, $ options)

Specifica l'URL che dovrebbe essere convertito into DOCX.

parametri

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

Valore di ritorno

nulla

HTMLToDOCX($ Html, $ options)

Specifica l'HTML che dovrebbe essere convertito into DOCX.

parametri

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

Valore di ritorno

nulla

FileToDOCX($ Path, $ options)

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 del GrabzItDOCXOptions classe che definisce eventuali opzioni speciali da utilizzare durante la creazione di un DOCX.

Valore di ritorno

nulla

GrabzItDOCXOptions

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

Proprietà pubbliche

  • customId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
    • Predefinito: vuoto
  • setIncludeBackground($value) - se 1 le immagini di sfondo della pagina Web devono essere incluse nello screenshot
    • Predefinito: 1
  • pagesize($value) - le dimensioni della pagina del DOCX
    • Predefinito: "A4"
    • Opzioni: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legale", "Lettera"
  • orientation($value) - l'orientamento del documento DOCX
    • Predefinito: "Ritratto"
    • Opzioni: "Ritratto", "Paesaggio"
  • includeLinks($value) - 1 se i collegamenti devono essere inclusi nel DOCX
    • Predefinito: 1
  • includeImages($value) - se 1 le immagini di sfondo della pagina Web devono essere incluse nello screenshot
    • Predefinito: 1
  • title($value) - fornire un titolo al documento DOCX
    • Predefinito: vuoto
  • marginTop($value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento DOCX
    • Predefinito: 10
  • marginLeft($value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento DOCX
    • Predefinito: 10
  • marginBottom($value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento DOCX
    • Predefinito: 10
  • marginRight($value) - il margine in millimetri che dovrebbe apparire alla destra del documento DOCX
    • Predefinito: 10
  • browserWidth($value) - 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
  • pageHeight - il altezza personalizzata del DOCX risultante in mm
  • delay($value) - il numero di millisecondi a attendere prima di fare lo screenshot
    • Predefinito: 0
    • Massimo: 30000
  • requestAs($value) - 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
      • 3 = indica che deve essere utilizzato l'agente utente di un browser di base
  • templateId($value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento DOCX
    • Predefinito: vuoto
  • targetElement($value) - 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($value) - 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($value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
    • Predefinito: vuoto
  • quality($value) - il qualità del DOCX restituito. L'impostazione predefinita utilizza la qualità consigliata per un DOCX.
    • La riduzione della qualità ridurrà le dimensioni del file e ridurrà i tempi di download.
    • Predefinito: -1
    • Minimo: -1
    • Massimo: 100
  • country($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Poiché Perl ha scarse funzionalità di crittografia nativa, è necessario segui queste istruzioni per decrittografare un'acquisizione crittografata.
    • Predefinito: vuoto
  • noAds($value) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • noCookieNotifications($value) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
    • Predefinito: falso
  • address($value) - l'URL in cui eseguire il codice HTML. Può essere utile se l'HTML da convertire utilizza URL relativi a risorse come CSS e immagini.
    • Predefinito: vuoto
  • proxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto
  • mergeId($value) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento DOCX
    • Predefinito: vuoto
  • password($value) - il password per proteggere il documento DOCX con i
    • Predefinito: vuoto

Metodi pubblici

  • AddPostParameter ($ name, $ value) - 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
  • AddTemplateParameter ($ name, $ value) - 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

URLToTable($ Url, $ options)

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 del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

HTMLToTable ($ html, $ options)

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 del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

FileToTable ($ path, $ options)

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 del GrabzItTableOptions classe che definisce eventuali opzioni speciali da utilizzare durante la conversione della tabella HTML.

Valore di ritorno

nulla

GrabzItTableOptions

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

Proprietà pubbliche

  • customId($value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato
    • Predefinito: vuoto
  • tableNumberToInclude($value) - 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($value) - il formato in cui deve essere la tabella
    • Predefinito: "csv"
    • Opzioni: "csv", "json", "xlsx"
  • includeHeaderNames($value) - se i nomi delle intestazioni 1 saranno inclusi nella tabella
    • Predefinito: 1
  • includeAllTables($value) - se 1 verrà estratta tutta la tabella della pagina Web con ciascuna tabella visualizzata in un foglio di calcolo separato. Disponibile solo con il formato XLSX
    • Predefinito: 0
  • targetElement($value) - l'id dell'unico elemento HTML nella pagina Web da cui utilizzare per estrarre le tabelle
    • Predefinito: vuoto
  • requestAs($value) - 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
      • 3 = indica che deve essere utilizzato l'agente utente di un browser di base
  • country($value) - 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($value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
    • Predefinito: vuoto
  • encryptionKey($value) - se viene specificata una chiave di crittografia AES con codifica 64 di base, la tua acquisizione viene crittografata quando viene creata. Poiché Perl ha scarse funzionalità di crittografia nativa, è necessario segui queste istruzioni per decrittografare un'acquisizione crittografata.
    • Predefinito: vuoto
  • address($value) - l'URL in cui eseguire il codice HTML. Può essere utile se l'HTML da convertire utilizza URL relativi a risorse come CSS e immagini.
    • Predefinito: vuoto
  • proxy($value) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
    • Predefinito: vuoto

Metodi pubblici

  • AddPostParameter ($ name, $ value) - 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

Questo è il metodo raccomandato per salvare un file

Save($ callBackURL = '')

Save il risultato in modo asincrono e restituisce un identificatore univoco, che può essere utilizzato per ottenere lo screenshot con il GetResult 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 GetResult metodo


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

SaveTo()

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

SaveTo($savetofile)

Save il risultato in modo sincrono in un file.

parametri

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

Valore di ritorno

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


GetStatus ($ id)

Ottieni lo stato corrente di uno screenshot di GrabzIt.

parametri

  • id - l'identificatore univoco dello screenshot
    • Obbligatorio

Valore di ritorno

GrabzItStatus oggetto


GetCookies ($ 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

GrabzItCookie schieramento


SetCookie ($ name, $ domain, $ value = '', $ path = '/', $ httponly = 0, $ 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 1 il cookie può essere utilizzato solo con il protocollo HTTP
  • scade: definisce quando scade il cookie. Passa un valore nullo se il cookie non deve scadere
    • Dovrebbe essere nel formato aaaa-mm-gg hh: mm: ss

Valore di ritorno

1 se il cookie è impostato correttamente, altrimenti 0


DeleteCookie ($ name, $ domain)

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

1 se il cookie viene eliminato correttamente, altrimenti 0


GetWaterMarks()

Ottieni le filigrane personalizzate caricate

Valore di ritorno

GrabzItWaterMark schieramento


GetWaterMark($ Identificatore)

Restituisce le filigrane personalizzate che corrispondono all'identificatore specificato

parametri

  • identificatore: l'identificatore di una particolare filigrana personalizzata che si desidera visualizzare
    • Obbligatorio

Valore di ritorno

GrabzItWaterMark


AggiungiWaterMark($ identificatore, $ percorso, $ xpos, $ ypos)

Aggiungi una nuova filigrana personalizzata

parametri

  • identificatore: l'identificatore che si desidera assegnare alla filigrana personalizzata. È importante che questo identificatore sia univoco.
    • Obbligatorio
  • percorso: il percorso assoluto della filigrana sul 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 1 se la filigrana è stata impostata correttamente


DeleteWaterMark($ Identificatore)

Elimina una filigrana personalizzata

parametri

  • identificatore: l'identificatore della filigrana personalizzata che si desidera eliminare
    • Obbligatorio

Valore di ritorno

restituisce 1 se la filigrana è stata eliminata correttamente


UseSSL ($ value)

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

parametri

  • valore - se 1 tutte le richieste all'API di GrabzIt utilizzerà SSL
    • Obbligatorio

Classi di risultati

GrabzItCookie

Metodi pubblici

  • getName ()
    • Il nome del cookie
  • getValue ()
    • Il valore del cookie
  • getDomain ()
    • Il dominio per cui è impostato il cookie.
  • getPath ()
    • Il percorso sul dominio a cui si applica questo cookie.
  • getHttpOnly ()
    • Se questo cookie è valido solo quando il sito Web viene visualizzato con il protocollo HTTP.
  • getExpires ()
    • La data di scadenza di questo cookie
  • getType ()
    • 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

GrabzItStatus

La classe che rappresenta lo stato corrente dello screenshot.

Metodi pubblici

  • getProcessing ()
    • Se 1 lo screenshot è ancora in fase di elaborazione.
  • getCached ()
    • Se 1 lo screenshot è stato elaborato ed è attualmente memorizzato nella cache.
  • getExpired ()
    • Se 1 lo screenshot non è più sul sistema GrabzIt.
  • getMessage ()
    • Un messaggio di errore restituito dal sistema.

GrabzItWaterMark

Questa classe rappresenta le filigrane personalizzate archiviate in GrabzIt

Metodi pubblici

  • getIdentifier ()
    • L'identificatore della filigrana
  • getXPosition ()
    • La posizione orizzontale della filigrana
      • Sinistra = 0
      • Centro = 1
      • Destra = 2
  • getYPosition ()
    • La posizione verticale della filigrana
      • Superiore = 0
      • Medio = 1
      • In basso = 2
  • GetFormat ()
    • Il formato della filigrana