Descrizione

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

Metodi pubblici

• GrabzItFile GetResult(String id)
• URLToAnimation(String url, AnimationOptions options)
• URLToImage(String url, ImageOptions options)
• HTMLToImage(String html, ImageOptions options)
• FileToImage(String path, ImageOptions options)
• URLToPDF(String url, PDFOptions options)
• HTMLToPDF(String html, PDFOptions options)
• FileToPDF(String path, PDFOptions options)
• URLToDOCX(String url, DOCXOptions options)
• HTMLToDOCX(String html, DOCXOptions options)
• FileToDOCX(String path, DOCXOptions options)
• URLToTable(String url, TableOptions options)
• HTMLToTable(String html, TableOptions options)
• FileToTable(String path, TableOptions options)
• URLToRenderedHTML(String url, HTMLOptions options)
• HTMLToRenderedHTML(String html, HTMLOptions options)
• FileToRenderedHTML(String path, HTMLOptions options)
• String Save()
• String Save(String callBackURL)
• GrabzItFile SaveTo()
• boolean SaveTo(String saveToFile)
• Status GetStatus(String id)
• GrabzItCookie[] GetCookies(String domain)
• boolean SetCookie(String name, String domain, String value, String path, boolean httponly, Date? expires)
• boolean DeleteCookie(String name, String domain)
• WaterMark[] GetWaterMarks()
• WaterMark GetWaterMark(String identifier)
• boolean AddWaterMark(String identifier, String path, HorizontalPosition xpos, VerticalPosition ypos)
• boolean DeleteWaterMark(String identifier)
• SetLocalProxy(String proxyUrl)
• UseSSL(boolean value)
• String CreateEncryptionKey()
• Decrypt(String path, String key)
• GrabzItFile Decrypt(GrabzItFile file, String key)
• byte[] Decrypt(byte[] data, String key)

GrabzItFile GetResult(String 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

GrabzItFile oggetto

---

URLToAnimation(String url, AnimationOptions opzioni)

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

• setCustomId(String value) - identificativo personalizzato che è possibile passare al servizio web GIF animato. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• setWidth(int 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ò)
• setHeight(int 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ò)
• setStart(int value) - la posizione iniziale del video che dovrebbe essere convertito into GIF animata.
  • Predefinito: 0 secondi
• setDuration(int value) - la lunghezza in secondi del video che dovrebbe essere convertito into GIF animata.
  • Predefinito: lunghezza massima per il pacchetto
• setSpeed(float value) - la velocità della GIF animata.
  • Predefinito: 1
  • Minimo: 0.2
  • Massimo: 10
• setFramesPerSecond(float value) - il numero di fotogrammi al secondo che devono essere acquisiti dal video.
  • Predefinito: 10
  • Minimo: 0.2
  • Massimo: 60
• setRepeat(int value) - numero di volte per eseguire il ciclo della GIF animata.
  • Predefinito: 0
  • Ciclo continuo: 0
  • Non ripetere mai: -1
• setReverse(boolean value) - se vero, i frame della GIF animata sono invertiti
  • Predefinito: falso
• setCustomWaterMarkId(String value) - aggiungi personalizzato watermark alla GIF animata
  • Predefinito: vuoto
• setQuality(int 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
• setCountry(Country value) - Paese la GIF animata dovrebbe essere presa da.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: Paese .SINGAPORE, Paese .REGNO UNITO, Paese .STATI UNITI
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

---

URLToImage(String url, ImageOptions opzioni)

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

HTMLToImage(String html, ImageOptions opzioni)

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

FileToImage(String sentiero, ImageOptions opzioni)

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

• setCustomId(String value) - identificativo personalizzato che è possibile passare al servizio web screenshot. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• setBrowserWidth(int value) - la larghezza del browser in pixel
  • Predefinito: 1366
  • Massimo: 10000
• setBrowserHeight(int value) - l'altezza del browser in pixel
  • Predefinito: 1170
  • Massimo: 10000
  • Lunghezza totale: -1 (passando -1 significa che viene presa una sequenza dell'intera pagina Web)
• setOutputWidth(int value) - la larghezza della miniatura risultante in pixel
  • Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se l'altezza dell'output è specificata, la larghezza dell'output sarà proporzionale all'altezza dell'output
  • Massima: larghezza massima per pacchetto
  • Larghezza intera: -1 (passando -1 significa che la larghezza della miniatura non viene ridotta)
• setOutputHeight(int value) - l'altezza della miniatura risultante in pixel
  • Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se la larghezza dell'output è specificata l'altezza dell'output sarà proporzionale alla larghezza dell'output
  • Massimo: altezza massima per pacchetto
  • Altezza totale: -1 (passando -1 significa che l'altezza della miniatura non viene ridotta)
• setFormat(ImageFormat value) - il formato in cui dovrebbe essere lo screenshot.
  • Predefinito: ImageFormat. JPG
  • Opzioni: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormatBMP, ImageFormat.tiff ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• setClickElement - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
• setTargetElement(String 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
• setHideElement(String 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
• setWaitForElement(String value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• setRequestAs(BrowserType value) - il tipo di agente utente che si desidera utilizzare
  • Predefinito: BrowserType.STANDARDBROWSER
  • Opzioni: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTORE DI RICERCA
• setCustomWaterMarkId(String value) - aggiungi una personalizzazione watermark all'immagine
  • Predefinito: vuoto
• setQuality(int value) - 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
• setTransparent(boolean value) - se vero il l'acquisizione delle immagini dovrebbe essere trasparente. Questo è compatibile solo con immagini png e tiff.
  • Predefinito: falso
• setHd(boolean value) - se vera l'immagine la cattura sarà in alta definizione questo raddoppia la dimensione delle dimensioni dell'immagine.
  • Predefinito: falso
• setCountry(Country value) - Paese lo screenshot dovrebbe essere preso da.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: Paese .SINGAPORE, Paese .REGNO UNITO, Paese .STATI UNITI
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setNoAds(boolean noAds) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setNoCookieNotifications(boolean noCookieNotifications) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setAddress(String 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• AddPostParameter (String nome, String 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

---

URLToRenderedHTML(String url, HTMLOptions opzioni)

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

HTMLToRenderedHTML(string html, HTMLOptions opzioni)

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

parametri

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

Valore di ritorno

nulla

FileToRenderedHTML(string sentiero, HTMLOptions opzioni)

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

• setCustomId(String value) - identificativo personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• setBrowserWidth(int value) - la larghezza del browser in pixel
  • Predefinito: 1366
  • Massimo: 10000
• setBrowserHeight(int value) - l'altezza del browser in pixel
  • Predefinito: 1170
  • Massimo: 10000
• setWaitForElement(String value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• setRequestAs(BrowserType value) - il tipo di agente utente che si desidera utilizzare
  • Predefinito: BrowserType.STANDARDBROWSER
  • Opzioni: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTORE DI RICERCA
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setNoAds(boolean noAds) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setNoCookieNotifications(boolean noCookieNotifications) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setAddress(String 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• AddPostParameter (String nome, String 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

---

URLToPDF(String url, PDFOptions opzioni)

Specifica l'URL che dovrebbe essere convertito into PDF.

parametri

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

Valore di ritorno

nulla

HTMLToPDF(String html, PDFOptions opzioni)

Specifica l'HTML che dovrebbe essere convertito into PDF.

parametri

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

Valore di ritorno

nulla

FileToPDF(String sentiero, PDFOptions opzioni)

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
• PDFOptions 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

• setCustomId(String value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• setIncludeBackground(boolean value) - se vero, lo sfondo della pagina Web deve essere incluso nello screenshot
  • Predefinito: vero
• setPageSize(PageSize value) - le dimensioni della pagina del PDF
  • Predefinito: PageSize.A4
  • Opzioni: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.LETTERA
• setOrientation(PageOrientation value) - l'orientamento del documento PDF
  • Predefinito: PageOrientation.RITRATTO
  • Opzioni: PageOrientation.RITRATTO, PageOrientation.PAESAGGIO
• setCSSMediaType(CSSMediaType value) - il Tipo di supporto CSS del documento PDF
  • Predefinito: CSSMediaType.SCHERMO
  • Opzioni: CSSMediaType.SCHERMO, CSSMediaType.PRINT
• setIncludeLinks(boolean value) - vero se i collegamenti devono essere inclusi nel PDF
  • Predefinito: vero
• setIncludeOutline(boolean value) - vero se Segnalibri PDF dovrebbe essere incluso
  • Predefinito: falso
• setTitle(String value) - fornire un titolo al documento PDF
  • Predefinito: vuoto
• setCoverURL(string value) - l'URL di una pagina Web che dovrebbe essere utilizzata come copertina per il PDF
  • Predefinito: vuoto
• setMarginTop(int value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento PDF
  • Predefinito: 10
• setMarginLeft(int value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento PDF
  • Predefinito: 10
• setMarginBottom(int value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento PDF
  • Predefinito: 10
• setMarginRight(int value) - il margine in millimetri che dovrebbe apparire alla destra del documento PDF
  • Predefinito: 10
• setBrowserWidth(int value) - La la larghezza del browser in pixel
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: 1366
  • Massimo: 10000
  • Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento PDF)
• setPageWidth(int value) - il larghezza personalizzata del PDF risultante in mm
  • Predefinito: PageSize larghezza
  • Minimo: 15
• setPageHeight(int value) - il altezza personalizzata del PDF risultante in mm
  • Predefinito: PageSize altezza
  • Minimo: 15
• setDelay(int value) - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• setRequestAs(BrowserType value) - il tipo di agente utente che si desidera utilizzare
  • Predefinito: BrowserType.STANDARDBROWSER
  • Opzioni: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTORE DI RICERCA
• setTemplateId(String value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento PDF
  • Predefinito: vuoto
• setClickElement - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
• setTargetElement(String 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
• setHideElement(String 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
• setWaitForElement(String value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• setCustomWaterMarkId(String value) - aggiungi una personalizzazione watermark a ciascuna pagina del documento PDF
  • Predefinito: vuoto
• setQuality(int value) - il qualità del PDF restituito. L'impostazione predefinita utilizza la qualità consigliata per il PDF.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• setCountry(Country value) - Paese lo screenshot dovrebbe essere preso da.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: Paese .SINGAPORE, Paese .REGNO UNITO, Paese .STATI UNITI
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setNoAds(boolean noAds) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setNoCookieNotifications(boolean noCookieNotifications) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setAddress(String 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto
• setMergeId(String mergeId) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento PDF
  • Predefinito: vuoto
• setPassword(String password) - il password per proteggere il documento PDF con
  • Predefinito: vuoto

Metodi pubblici

• AddPostParameter (String nome, String 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
• AddTemplateParameter (String nome, String 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

---

URLToDOCX (String url, DOCXOptions opzioni)

Specifica l'URL che dovrebbe essere convertito into DOCX.

parametri

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

Valore di ritorno

nulla

HTMLToDOCX(String html, DOCXOptions opzioni)

Specifica l'HTML che dovrebbe essere convertito into DOCX.

parametri

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

Valore di ritorno

nulla

FileToDOCX(String sentiero, DOCXOptions opzioni)

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
• DOCXOptions 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

• setCustomId(String value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato.
  • Predefinito: vuoto
• setIncludeBackground(boolean value) - se vero, le immagini di sfondo della pagina Web devono essere incluse nel DOCX
  • Predefinito: vero
• setPageSize(PageSize value) - le dimensioni della pagina del DOCX
  • Predefinito: PageSize.A4
  • Opzioni: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.LETTERA
• setOrientation(PageOrientation value) - l'orientamento del documento DOCX
  • Predefinito: PageOrientation.RITRATTO
  • Opzioni: PageOrientation.RITRATTO, PageOrientation.PAESAGGIO
• setIncludeLinks(boolean value) - true se i collegamenti devono essere inclusi nel DOCX
  • Predefinito: vero
• setIncludeImages(boolean value) - se vero, le immagini della pagina Web devono essere incluse nel DOCX
  • Predefinito: vero
• setTitle(String value) - fornire un titolo al documento DOCX
  • Predefinito: vuoto
• setMarginTop(int value) - il margine in millimetri che dovrebbe apparire nella parte superiore della pagina del documento DOCX
  • Predefinito: 10
• setMarginLeft(int value) - il margine in millimetri che dovrebbe apparire a sinistra della pagina del documento DOCX
  • Predefinito: 10
• setMarginBottom(int value) - il margine in millimetri che dovrebbe apparire nella parte inferiore della pagina del documento DOCX
  • Predefinito: 10
• setMarginRight(int value) - il margine in millimetri che dovrebbe apparire alla destra del documento DOCX
  • Predefinito: 10
• setBrowserWidth(int value) - il larghezza del browser in pixel
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
  • Predefinito: 1366
  • Massimo: 10000
  • Larghezza automatica: -1 (passando -1 significa che la larghezza del browser corrisponde alla larghezza del documento PDF)
• setPageWidth(int value) - il larghezza personalizzata del DOCX risultante in mm
  • Predefinito: PageSize larghezza
  • Minimo: 15
• setPageHeight(int value) - il altezza personalizzata del DOCX risultante in mm
  • Predefinito: PageSize altezza
  • Minimo: 15
• setDelay(int value) - il numero di millisecondi a attendere prima di fare lo screenshot
  • Predefinito: 0
  • Massimo: 30000
• setRequestAs(BrowserType value) - il tipo di agente utente che si desidera utilizzare
  • Predefinito: BrowserType.STANDARDBROWSER
  • Opzioni: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTORE DI RICERCA
• setTemplateId(String value) - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento DOCX
  • Predefinito: vuoto
• setClickElement - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
  • Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
• setTargetElement(String 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
• setHideElement(String 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
• setWaitForElement(String value) - il Selettori CSS dell'elemento HTML nella pagina Web che deve essere visibile prima di eseguire l'acquisizione
  • Predefinito: vuoto
• setQuality(int value) - il qualità del DOCX restituito. L'impostazione predefinita utilizza la qualità consigliata per DOCX.
  • Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
  • Predefinito: -1
  • Minimo: -1
  • Massimo: 100
• setCountry(Country value) - Paese lo screenshot dovrebbe essere preso da.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: Paese .SINGAPORE, Paese .REGNO UNITO, Paese .STATI UNITI
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setNoAds(boolean noAds) - se è vero le pubblicità dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setNoCookieNotifications(boolean noCookieNotifications) - se vero, tutto ciò che si trova comunemente le notifiche dei cookie dovrebbero essere nascoste automaticamente.
  • Predefinito: falso
• setAddress(String 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto
• setMergeId(String mergeId) - l'ID di una cattura che dovrebbe essere unito all'inizio del nuovo documento DOCX
  • Predefinito: vuoto
• setPassword(String mergeId) - il password per proteggere il documento DOCX con
  • Predefinito: vuoto

Metodi pubblici

• AddPostParameter (String nome, String 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
• AddTemplateParameter (String nome, String 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

---

URLToTable(String url, TableOptions opzioni)

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

parametri

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

Valore di ritorno

nulla

HTMLToTable (String html, TableOptions opzioni)

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

parametri

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

Valore di ritorno

nulla

FileToTable (String sentiero, TableOptions opzioni)

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
• TableOptions 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

• setCustomId(String value) - un identificatore personalizzato che è possibile passare al servizio web. Questo verrà restituito con l'URL di callback che hai specificato
  • Predefinito: vuoto
• setTableNumberToInclude(int 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
• setFormat(TableFormat value) - il formato in cui deve essere la tabella
  • Predefinito: TableFormatCSV
  • Opzioni: TableFormatCSV, TableFormat.json, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - se nella tabella saranno inclusi i nomi di intestazioni vere
  • Predefinito: vero
• setIncludeAllTables(boolean value) - 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
• setTargetElement(String value) - l'id dell'unico elemento HTML nella pagina Web da cui utilizzare per estrarre le tabelle
  • Predefinito: vuoto
• setRequestAs(BrowserType value) - il tipo di agente utente che si desidera utilizzare
  • Predefinito: BrowserType.STANDARDBROWSER
  • Opzioni: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTORE DI RICERCA
• setCountry(Country value) - Paese lo screenshot dovrebbe essere preso da.
  • Predefinito: la posizione più veloce corrente
  • Opzioni: Paese .SINGAPORE, Paese .REGNO UNITO, Paese .STATI UNITI
• setExportURL(String value) - il URL di esportazione che specifica dove esportare anche l'acquisizione
  • Predefinito: vuoto
• setEncryptionKey(String key) - 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
• setAddress(String 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
• setProxy(String proxy) - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
  • Predefinito: vuoto

Metodi pubblici

• AddPostParameter (String nome, String 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()

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

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

---

Save(String 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
  • Obbligatorio

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

GrabzItFile SaveTo()

Save il risultato in modo sincrono con a GrabzItFile oggetto.

Valore di ritorno

GrabzItFile oggetto

---

SaveTo(String saveToFare la fila)

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.

---

STATO GetStatus (String id)

Ottieni lo stato corrente di uno screenshot di GrabzIt.

parametri

• id - l'identificatore univoco dello screenshot
  • Obbligatorio

Valore di ritorno

STATO oggetto

---

GrabzItCookie [] getCookies (String 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 (String nome, String dominio, String valore, String sentiero, boolean httponly, Data di scadenza)

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 nullo se il cookie non deve scadere

Valore di ritorno

Vero se il cookie è impostato correttamente, altrimenti falso

---

DeleteCookie (String nome, String 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

---

WaterMark[] OttieniWaterMarks()

Ottieni tutte le tue personalizzazioni caricate watermarks

Valore di ritorno

WaterMark schieramento

---

WaterMark OttieniWaterMark(String identificatore)

Restituisci la tua abitudine watermarks che corrisponde all'identificatore specificato

parametri

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

Valore di ritorno

WaterMark oggetto

---

AggiungiWaterMark(String identificatore, String sentiero, HorizontalPosition xpos, VerticalPosition 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: HorizontalPosition.SINISTRA, HorizontalPosition.CENTRO, HorizontalPosition.DESTRA
• ypos - posizione verticale in cui vuoi che appaia lo screenshot
  • Obbligatorio
  • Opzioni: VerticalPosition.SUPERIORE, VerticalPosition.MIDDLE, VerticalPosition.PARTE INFERIORE

Valore di ritorno

restituisce vero se il watermark è stato impostato con successo

---

DeleteWaterMark(String 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

---

SetLocalProxy (String proxyurl)

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

---

UseSSL (boolean 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

---

String CreateEncryptionKey ()

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

---

Decrypt (String sentiero, String 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

---

GrabzItFile Decrypt (GrabzItFile file, String chiave)

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

parametri

• file: il crittografato GrabzItFile
  • Obbligatorio
• chiave - il chiave di crittografia
  • Obbligatorio

---

byte [] Decrypt (byte [] data, String chiave)

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

parametri

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

---

Enums

ImageFormat

Questo enum comprende i seguenti valori.

• BMP8
• BMP16
• BMP24
• BMP
• JPG
• TIFF
• PNG
• WebP

---

BrowserType

Questo enum comprende i seguenti valori.

• STANDARDBROWSER
• browser mobile
• MOTORE DI RICERCA

---

Paese

Questo enum comprende i seguenti valori.

• PREDEFINITO
• SINGAPORE
• REGNO UNITO
• STATI UNITI

---

PageSize

Questo enum comprende i seguenti valori.

• A3
• A4
• A5
• A6
• B3
• B4
• B5
• B6
• LEGAL
• LETTERA

---

PageOrientation

Questo enum comprende i seguenti valori.

• PAESAGGIO
• RITRATTO

---

CSSMediaType

Questo enum comprende i seguenti valori.

• PRINT
• SCREEN

---

TableFormat

Questo enum comprende i seguenti valori.

• CSV
• JSON
• XSLX

---

HorizontalPosition

Questo enum comprende i seguenti valori.

• SINISTRA
• CENTRO
• DESTRA

---

VerticalPosition

Questo enum comprende i seguenti valori.

• TOP
• MEDIO
• FONDO

---

Classi di risultati

Cookies

Proprietà pubbliche

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

GrabzItFile

Metodi pubblici

• byte [] getBytes ()
• nulla Save(String percorso)
• String aString()

STATO

La classe che rappresenta lo stato corrente dello screenshot.

Metodi pubblici

• boolean isProcessing ()
  • Se vero, lo screenshot è ancora in fase di elaborazione.
• boolean isCached ()
  • Se vero, lo screenshot è stato elaborato ed è attualmente memorizzato nella cache.
• boolean è scaduto()
  • Se vero, lo screenshot non è più sul sistema GrabzIt.
• String getMessage ()
  • Un messaggio di errore restituito dal sistema.

WaterMark

Questa classe rappresenta l'usanza watermarks archiviato in GrabzIt

Metodi pubblici

• String getIdentifier ()
• String GetFormat ()
• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()