GrabzIt-client met Ruby

Beschrijving

Deze klasse verzorgt alle communicatie met de GrabzIt-screenshotwebservices.

Publieke methoden

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

Deze methode retourneert de screenshot zelf. Als er niets wordt geretourneerd, is er iets misgegaan of is de screenshot nog niet gereed.

parameters

• id - de unieke identificatie van de screenshot
  • Nodig

Winstwaarde

De vangst

url_to_animation(Url, opties = nul)

Geef de URL op van de online video die moet worden geconverteerd intoa geanimeerde GIF.

parameters

• url - de URL van de online video die moet worden geconverteerd into een geanimeerde GIF.
  • Nodig
  • Accepteert Vimeo en YouTube video-URL's
    • Waarschuwing voor het animeren van Vimeo- en YouTube-video's is afhankelijk van een derde partij en biedt dus mogelijk geen consistente resultaten.
• opties - een exemplaar van de AnimationOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de geanimeerde GIF.

Winstwaarde

komen te vervallen

AnimationOptions

De klasse vertegenwoordigt alle beschikbare opties bij het maken van een geanimeerde GIF.

Publieke eigenschappen

• customId - aangepaste id die u kunt doorgeven aan de geanimeerde GIF-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
  • Standaard: leeg
• width - de breedte van de resulterende geanimeerde GIF in pixels.
  • Standaard: 180px
  • Maximum: maximale breedte voor pakket
  • Auto-formaat: -1 (passerend -1 betekent dat de breedte van de geanimeerde GIF is geschaald in verhouding tot de hoogte, als de breedte automatisch wordt aangepast, kan de hoogte niet)
• height - de hoogte van de resulterende geanimeerde GIF in pixels.
  • Standaard: 120px
  • Maximum: maximale hoogte voor pakket
  • Auto-formaat: -1 (passeren van -1 betekent dat de hoogte van de geanimeerde GIF is geschaald in verhouding tot de breedte, als de hoogte automatisch wordt aangepast, kan de breedte niet)
• start - de startpositie van de video die moet worden geconverteerd intoa geanimeerde GIF.
  • Standaard: 0 seconden
• duration - de lengte in seconden van de video die moet worden geconverteerd intoa geanimeerde GIF.
  • Standaard: maximale lengte voor pakket
• speed - de snelheid van de geanimeerde GIF.
  • Standaard: 1
  • Minimum: 0.2
  • Maximaal: 10
• framesPerSecond - het aantal frames per seconde dat moet worden vastgelegd van de video.
  • Standaard: 10
  • Minimum: 0.2
  • Maximaal: 60
• repeat - aantal keren dat de geanimeerde GIF in een lus moet worden geplaatst.
  • Standaard: 0
  • Lus continu: 0
• reverse - indien waar, worden de frames van de geanimeerde GIF omgekeerd
  • Standaard: false
• customWaterMarkId - voeg een aangepast watermerk toe aan de geanimeerde GIF
  • Standaard: leeg
• quality - de kwaliteit van de geretourneerde afbeelding, die een standaardcompressie van 85% heeft.
  • Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
  • Standaard: -1
  • Minimum: -1
  • Maximaal: 100
• country - het land de geanimeerde GIF moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg

url_to_image(Url, opties = nul)

Hiermee geeft u de URL op die moet worden geconverteerd intoa afbeelding screenshot.

parameters

• url - de URL waarvan het screenshot moet worden gemaakt
  • Nodig
• opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de schermafbeelding.

Winstwaarde

komen te vervallen

html_to_image(Html, opties = nul)

Hiermee geeft u de HTML op die moet worden geconverteerd inteen afbeelding.

parameters

• html - de HTML om te zetten inteen afbeelding
  • Nodig
• opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.

Winstwaarde

komen te vervallen

file_to_image(pad, opties = nul)

Geeft een HTML-bestand aan dat moet worden geconverteerd inteen afbeelding.

parameters

• pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd inteen afbeelding
  • Nodig
• opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.

Winstwaarde

komen te vervallen

ImageOptions

De klasse vertegenwoordigt alle beschikbare opties bij het maken van afbeeldingen.

Publieke eigenschappen

• customId - aangepaste id die u kunt doorgeven aan de screenshot-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
  • Standaard: leeg
• browserWidth - de breedte van de browser in pixels
  • Standaard: 1024
  • Maximaal: 10000
• browserHeight - de hoogte van de browser in pixels
  • Standaard: 768
  • Maximaal: 10000
  • Volledige lengte: -1 (doorgeven van -1 betekent dat een sceenshot van de hele webpagina wordt gemaakt)
• width - de breedte van de resulterende miniatuur in pixels
  • Standaard: de hoogst mogelijke browserbreedte die binnen de maximale breedte voor het gebruikerspakket past
  • Maximum: maximale breedte voor pakket
  • Volledige breedte: -1 (passeren van -1 betekent dat de breedte van de miniatuur niet wordt verkleind)
• height - de hoogte van de resulterende miniatuur in pixels
  • Standaard: de hoogst mogelijke browserhoogte die binnen de maximale hoogte voor het gebruikerspakket past
  • Maximum: maximale hoogte voor pakket
  • Volledige hoogte: -1 (doorgeven van -1 betekent dat de hoogte van de miniatuur niet wordt verkleind)
• format - het formaat waarin de screenshot moet zijn.
  • Standaard: "jpg"
  • Opties: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
• delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
  • Standaard: 0
  • Maximaal: 30000
• targetElement - de id of klasse CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa screenshot, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
  • Standaard: leeg
• hideElement - de id of klasse CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
  • Standaard: leeg
• waitForElement - de id of klasse CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
  • Standaard: leeg
• requestAs - het type user-agent dat u wilt gebruiken
  • Standaard: 0
  • Opties:
    • 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
    • 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
    • 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
    • 3 = geeft aan dat de user-agent van een basisbrowser moet worden gebruikt
• customWaterMarkId - voeg een aangepast watermerk toe aan de afbeelding
  • Standaard: leeg
• quality - de kwaliteit van de geretourneerde afbeelding. Dit heeft momenteel alleen effect op JPG-afbeeldingen, die standaard een compressie van 85% hebben.
  • Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
  • Standaard: -1
  • Minimum: -1
  • Maximaal: 100
• transparent - indien waar beeldopname moet transparant zijn. Dit is alleen compatibel met png- en tiff-afbeeldingen.
  • Standaard: false
• hd - indien waar de afbeelding vastleggen zal in hoge definitie zijn dit verdubbelt de grootte van de afbeeldingsafmetingen.
  • Standaard: false
• country - het land de schermafbeelding moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• noAds - als het waar is advertenties moeten automatisch worden verborgen.
  • Standaard: false
• noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
  • Standaard: false
• address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg

Publieke methoden

• add_post_parameter (naam, waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
  • naam - de naam van de parameter HTTP Post
  • waarde - de waarde van de parameter HTTP Post

url_to_rendered_html(Url, opties = nul)

Hiermee geeft u de URL op die moet worden geconverteerd into gerenderde HTML.

parameters

• url - de URL waarvan de gerenderde HTML moet worden gemaakt
  • Nodig
• opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de gerenderde HTML.

Winstwaarde

komen te vervallen

html_to_rendered_html(Html, opties = nul)

Hiermee geeft u de HTML op die moet worden geconverteerd into gerenderde HTML.

parameters

• html - de HTML om te zetten into gerenderde HTML
  • Nodig
• opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.

Winstwaarde

komen te vervallen

file_to_rendered_html(pad, opties = nul)

Geeft een HTML-bestand aan dat moet worden geconverteerd into gerenderde HTML.

parameters

• pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd into gerenderde HTML
  • Nodig
• opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.

Winstwaarde

komen te vervallen

HTMLOptions

De klasse vertegenwoordigt alle beschikbare opties wanneer gerenderde HTML-vastleggingen maken.

Publieke eigenschappen

• customId - aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
  • Standaard: leeg
• browserWidth - de breedte van de browser in pixels
  • Standaard: 1024
  • Maximaal: 10000
• browserHeight - de hoogte van de browser in pixels
  • Standaard: 768
  • Maximaal: 10000
• waitForElement - de id of klasse CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
  • Standaard: leeg
• requestAs - het type user-agent dat u wilt gebruiken
  • Standaard: 0
  • Opties:
    • 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
    • 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
    • 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
    • 3 = geeft aan dat de user-agent van een basisbrowser moet worden gebruikt
• country - het land de schermafbeelding moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• noAds - als het waar is advertenties moeten automatisch worden verborgen.
  • Standaard: false
• noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
  • Standaard: false
• address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg

Publieke methoden

• add_post_parameter (naam, waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
  • naam - de naam van de parameter HTTP Post
  • waarde - de waarde van de parameter HTTP Post

url_to_pdf(Url, opties = nul)

Hiermee geeft u de URL op die moet worden geconverteerd intoa PDF.

parameters

• url - de URL die moet worden geconverteerd intoa PDF
  • Nodig
• opties - een instantie van de klasse PDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

html_to_pdf(Html, opties = nul)

Hiermee geeft u de HTML op die moet worden geconverteerd intoa PDF.

parameters

• html - de HTML om te zetten intoa PDF
  • Nodig
• opties - een instantie van de klasse PDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

file_to_pdf(pad, opties = nul)

Geeft een HTML-bestand aan dat moet worden geconverteerd intoa PDF.

parameters

• pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa PDF
  • Nodig
• opties - een instantie van de klasse PDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.

Winstwaarde

komen te vervallen

PDFOptions

De klasse vertegenwoordigt alle beschikbare opties bij het maken van PDF-opnames.

Publieke eigenschappen

• customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
  • Standaard: leeg
• includeBackground - indien waar, moet de achtergrond van de webpagina in de screenshot worden opgenomen
  • Standaard: waar
• pagesize - het paginaformaat van de PDF
  • Standaard: "A4"
  • Opties: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
• orientation - de richting van het PDF-document
  • Standaard: "Portrait"
  • Opties: "Portret", "Landschap"
• cssMediaType - de CSS-mediatype van het PDF-document
  • Standaard: "Screen"
  • Opties: "Scherm", "Print"
• includeLinks - waar als links in de PDF moeten worden opgenomen
  • Standaard: waar
• includeOutline - waar als PDF-bladwijzers moet worden opgenomen
  • Standaard: false
• title - geef een titel op voor het PDF-document
  • Standaard: leeg
• coverURL - de URL van een webpagina die als voorblad voor de PDF moet worden gebruikt
  • Standaard: leeg
• marginTop - de marge in millimeter die bovenaan de PDF-documentpagina moet verschijnen
  • Standaard: 10
• marginLeft - de marge in millimeters die links van de PDF-documentpagina moet verschijnen
  • Standaard: 10
• marginBottom - de marge in millimeter die onderaan de PDF-documentpagina moet verschijnen
  • Standaard: 10
• marginRight - de marge in millimeters die rechts van het PDF-document moet verschijnen
  • Standaard: 10
• browserWidth - de breedte van de browser in pixels
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: 1024
  • Maximaal: 10000
  • Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het PDF-document)
• pageWidth - de aangepaste breedte van de resulterende PDF in mm
  • Standaard: paginaformaat breedte
  • Minimum: 15
• pageHeight - de aangepaste hoogte van de resulterende PDF in mm
  • Standaard: paginaformaat hoogte
  • Minimum: 15
• delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
  • Standaard: 0
  • Maximaal: 30000
• requestAs - het type user-agent dat u wilt gebruiken
  • Standaard: 0
  • Opties:
    • 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
    • 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
    • 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
    • 3 = geeft aan dat de user-agent van een basisbrowser moet worden gebruikt
• templateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het PDF-document aangeeft
  • Standaard: leeg
• targetElement - de id of klasse CSS-selector van de enige HTML-element op de doelpagina die moet worden omgedraaid intoa PDF, worden alle andere delen van de webpagina genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
  • Standaard: leeg
• hideElement - de id of klasse CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
  • Standaard: leeg
• waitForElement - de id of klasse CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
  • Standaard: leeg
• customWaterMarkId - voeg een aangepast watermerk toe aan elke pagina van het PDF-document
  • Standaard: leeg
• quality - de kwaliteit van de geretourneerde PDF. De standaard gebruikt de aanbevolen kwaliteit voor een PDF.
  • Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
  • Standaard: -1
  • Minimum: -1
  • Maximaal: 100
• country - het land de schermafbeelding moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• noAds - als het waar is advertenties moeten automatisch worden verborgen.
  • Standaard: false
• noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
  • Standaard: false
• address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg
• mergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe PDF-document
  • Standaard: leeg
• password - de wachtwoord om het PDF-document te beschermen met in de titel
  • Standaard: leeg

Publieke methoden

• add_post_parameter (naam, waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
  • naam - de naam van de parameter HTTP Post
  • waarde - de waarde van de parameter HTTP Post
• add_template_parameter (naam, waarde) - definieer een aangepaste sjabloon parameter en waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen.
  • naam - de naam van de sjabloonparameter
  • waarde - de waarde van de sjabloonparameter

url_to_docx(Url, opties = nul)

Hiermee geeft u de URL op die moet worden geconverteerd intoa DOCX.

parameters

• url - de URL die moet worden geconverteerd intoa DOCX
  • Nodig
• opties - een exemplaar van de DOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

html_to_docx(Html, opties = nul)

Hiermee geeft u de HTML op die moet worden geconverteerd intoa DOCX.

parameters

• html - de HTML om te zetten intoa DOCX
  • Nodig
• opties - een exemplaar van de DOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

file_to_docx(pad, opties = nul)

Geeft een HTML-bestand aan dat moet worden geconverteerd intoa DOCX.

parameters

• pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa DOCX
  • Nodig
• opties - een exemplaar van de DOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.

Winstwaarde

komen te vervallen

DOCXOptions

De klasse vertegenwoordigt alle beschikbare opties bij het maken van DOCX-opnames.

Publieke eigenschappen

• customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
  • Standaard: leeg
• includeBackground - indien waar, moeten de achtergrondafbeeldingen van de webpagina worden opgenomen in de DOCX
  • Standaard: waar
• pagesize - het paginaformaat van de DOCX
  • Standaard: "A4"
  • Opties: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
• orientation - de richting van het DOCX-document
  • Standaard: "Portrait"
  • Opties: "Portret", "Landschap"
• includeLinks - waar als links moeten worden opgenomen in de DOCX
  • Standaard: waar
• includeImages - indien waar, moeten de afbeeldingen van de webpagina worden opgenomen in de DOCX
  • Standaard: waar
• title - geef een titel op voor het DOCX-document
  • Standaard: leeg
• marginTop - de marge in millimeters die bovenaan de DOCX-documentpagina moet verschijnen
  • Standaard: 10
• marginLeft - de marge in millimeters die links van de DOCX-documentpagina moet verschijnen
  • Standaard: 10
• marginBottom - de marge in millimeter die onderaan de DOCX-documentpagina moet verschijnen
  • Standaard: 10
• marginRight - de marge in millimeter die rechts van het DOCX-document moet verschijnen
  • Standaard: 10
• browserWidth - de breedte van de browser in pixels
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: 1024
  • Maximaal: 10000
  • Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het DOCX-document)
• pageWidth - de aangepaste breedte van de resulterende DOCX in mm
  • Standaard: paginaformaat breedte
  • Minimum: 15
• pageHeight - de aangepaste hoogte van de resulterende DOCX in mm
  • Standaard: paginaformaat hoogte
  • Minimum: 15
• delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
  • Standaard: 0
  • Maximaal: 30000
• requestAs - het type user-agent dat u wilt gebruiken
  • Standaard: 0
  • Opties:
    • 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
    • 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
    • 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
    • 3 = geeft aan dat de user-agent van een basisbrowser moet worden gebruikt
• templateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het DOCX-document aangeeft
  • Standaard: leeg
• targetElement - de id of klasse CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa DOCX, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
  • Standaard: leeg
• hideElement - de id of klasse CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
  • Standaard: leeg
• waitForElement - de id of klasse CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
  • Standaard: leeg
• quality - de kwaliteit van de geretourneerde DOCX. De standaard gebruikt de aanbevolen kwaliteit voor een DOCX.
  • Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
  • Standaard: -1
  • Minimum: -1
  • Maximaal: 100
• country - het land de schermafbeelding moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• noAds - als het waar is advertenties moeten automatisch worden verborgen.
  • Standaard: false
• noCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
  • Standaard: false
• address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg
• mergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe DOCX-document
  • Standaard: leeg
• password - de wachtwoord om het DOCX-document te beschermen met in de titel
  • Standaard: leeg

Publieke methoden

• add_post_parameter (naam, waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
  • naam - de naam van de parameter HTTP Post
  • waarde - de waarde van de parameter HTTP Post
• add_template_parameter (naam, waarde) - definieer een aangepaste sjabloon parameter en waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen.
  • naam - de naam van de sjabloonparameter
  • waarde - de waarde van de sjabloonparameter

url_to_table(Url, opties = nul)

Hiermee geeft u de URL op waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

• url - de URL om HTML-tabellen uit te extraheren
  • Nodig
• opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

html_to_table(Html, opties = nul)

Hiermee geeft u de HTML op waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

• html - de HTML om HTML-tabellen uit te extraheren.
  • Nodig
• opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

file_to_table(pad, opties = nul)

Geeft een HTML-bestand aan waaruit de HTML-tabellen moeten worden geëxtraheerd.

parameters

• pad - het bestandspad van een HTML-bestand om HTML-tabellen uit te extraheren.
  • Nodig
• opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.

Winstwaarde

komen te vervallen

TableOptions

De klasse vertegenwoordigt alle beschikbare opties bij het converteren van HTML-tabellen naar CSV, XLSX of JSON.

Publieke eigenschappen

• customId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL
  • Standaard: leeg
• tableNumberToInclude - de index van de te converteren tabel, waarbij alle tabellen op een webpagina van boven naar beneden zijn geordend
  • Standaard: 1
• format - het formaat waarin de tabel moet zijn
  • Standaard: "csv"
  • Opties: "csv", "json", "xlsx"
• includeHeaderNames - of echte kopnamen in de tabel worden opgenomen
  • Standaard: waar
• includeAllTables - indien waar, worden alle tabellen op de webpagina geëxtraheerd en wordt elke tabel weergegeven in een afzonderlijk spreadsheetblad. Alleen beschikbaar met het XLSX-formaat
  • Standaard: false
• targetElement - de id van het enige HTML-element op de webpagina dat moet worden gebruikt om tabellen uit te halen
  • Standaard: leeg
• requestAs - het type user-agent dat u wilt gebruiken
  • Standaard: 0
  • Opties:
    • 0 = geeft aan dat de user-agent van een standaardbrowser moet worden gebruikt
    • 1 = geeft aan dat de user-agent van een mobiele browser moet worden gebruikt
    • 2 = geeft aan dat de user-agent van een zoekmachine moet worden gebruikt
    • 3 = geeft aan dat de user-agent van een basisbrowser moet worden gebruikt
• country - het land de schermafbeelding moet worden overgenomen.
  • Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
  • Standaard: de huidige snelste locatie
  • Opties: "SG", "UK", "US"
• exportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
  • Standaard: leeg
• encryptionKey - als een met 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
  • Standaard: leeg
• address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
  • Standaard: leeg
• proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
  • Standaard: leeg

Publieke methoden

• add_post_parameter (naam, waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
  • naam - de naam van de parameter HTTP Post
  • waarde - de waarde van de parameter HTTP Post

save(callBackURL = nul)

Save het resultaat asynchroon en retourneert een unieke identificatie, die kan worden gebruikt om de screenshot met de te krijgen get_result methode.

parameters

• callBackURL - de handler de GrabzIt-service moet bellen nadat deze zijn werk heeft voltooid

Winstwaarde

De unieke identificatie van de screenshot anders wordt een uitzondering gegenereerd als er een fout is opgetreden. Dit kan worden gebruikt om een ​​screenshot te krijgen met de methode get_result

save_to()

Save het resultaat synchroon met een variabele die de screenshotbytegegevens bevat.

Winstwaarde

geeft de bytegegevens van het bestand terug als dit succesvol is, anders wordt een uitzondering gegenereerd.

save_to(saveToFile)

Save het resultaat synchroon met een bestand.

parameters

• saveToFile - het bestandspad dat wordt vastgelegd saved tot het eenmaal is voltooid
  • Nodig

Winstwaarde

geeft de true terug als het succesvol is, anders wordt een uitzondering gegenereerd.

get_status(ID kaart)

Download de huidige status van een GrabzIt-schermafbeelding.

parameters

• id - de unieke identificatie van de screenshot
  • Nodig

Winstwaarde

ScreenShotStatus object

get_cookies(domein)

Download alle cookies die GrabzIt voor een bepaald domein gebruikt. Dit kan ook door de gebruiker gedefinieerde cookies zijn.

parameters

• domein - het domein waarvoor cookies worden geretourneerd
  • Nodig

Winstwaarde

koekje reeks

set_cookie (naam, domein, waarde = "", path = "/", httponly = false, verloopt = "")

Stelt een nieuwe aangepaste cookie in op GrabzIt, als de aangepaste cookie dezelfde naam en hetzelfde domein heeft als een globale cookie, wordt de globale cookie genegeerd.

Dit kan handig zijn als de functionaliteit van een website wordt beheerd door cookies.

parameters

• naam - de naam van de cookie die moet worden ingesteld
  • Nodig
• domein - het domein van de website waarvoor de cookie wordt ingesteld
  • Nodig
• waarde - de waarde van de cookie
• pad - het websitepad waar de cookie betrekking op heeft
• httponly - indien waar, kan de cookie alleen worden gebruikt met het HTTP-protocol
• verloopt - bepaalt wanneer de cookie verloopt. Geef een nulwaarde door als de cookie niet vervalt
  • Moet de indeling jjjj-mm-dd hh hebben: mm: ss

Winstwaarde

Waar als de cookie succesvol is ingesteld, anders onwaar

delete_cookie (naam, domein)

Verwijder een aangepaste cookie of blokkeer het gebruik van een globale cookie

parameters

• naam - de naam van de te verwijderen cookie
  • Nodig
• domein - het domein van de website waarvoor de cookie moet worden verwijderd
  • Nodig

Winstwaarde

Waar als de cookie succesvol is verwijderd, anders onwaar

get_watermarks ()

Download uw geüploade aangepaste watermerken

Winstwaarde

WaterMark reeks

get_watermark (identifier)

Download uw geüploade aangepaste watermerken

parameters

• identifier - de identifier van een bepaald aangepast watermerk dat u wilt bekijken
  • Nodig

Winstwaarde

WaterMark

add_watermark (identifier, pad, xpos, ypos)

Voeg een nieuw aangepast watermerk toe

parameters

• identifier - de identifier die u het aangepaste watermerk wilt geven. Het is belangrijk dat deze identifier uniek is.
  • Nodig
• pad - het absolute pad van het watermerk op uw server. Bijvoorbeeld C: /watermark/1.png
  • Nodig
• xpos - de horizontale positie waarop u de schermafbeelding wilt weergeven
  • Nodig
  • Opties:
    • Links = 0
    • Midden = 1
    • Rechts = 2
• ypos - verticale positie waarin u de schermafbeelding wilt weergeven
  • Nodig
  • Opties:
    • Boven = 0
    • Midden = 1
    • Onder = 2

Winstwaarde

geeft true terug als het watermerk succesvol is ingesteld

delete_watermark (identifier)

Verwijder een aangepast watermerk

parameters

• identifier - de identifier van het aangepaste watermerk dat u wilt verwijderen
  • Nodig

Winstwaarde

geeft true terug als het watermerk succesvol is verwijderd

set_local_proxy (value)

Met deze methode kan een lokale proxyserver te gebruiken voor alle verzoeken.

parameters

• proxyUrl - de URL, die indien nodig een poort kan bevatten, van de proxy. Als u een null opgeeft, wordt alle eerder ingestelde proxy verwijderd
  • Nodig

use_ssl (value)

Geeft aan of verzoeken aan GrabzIt's zijn API moet SSL gebruiken

parameters

• waarde - indien true zullen alle verzoeken aan de API van GrabzIt SSL gebruiken
  • Nodig

create_encryption_key ()

Maak een cryptografisch veilige basis 64-coderingssleutel, 44-tekens lang.

decoderen (data, sleutel)

Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.

parameters

• data - de gecodeerde bytes
  • Nodig
• sleutel - de coderingssleutel
  • Nodig

decrypt_file (pad, sleutel)

Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.

parameters

• pad - het pad van de gecodeerde opname
  • Nodig
• sleutel - de coderingssleutel
  • Nodig

Resultaatklassen

koekje

Publieke eigenschappen

• name
  • De cookienaam.
• value
  • De cookiewaarde.
• domain
  • Het domein waarvoor de cookie is ingesteld.
• path
  • Het pad op het domein waarop deze cookie van toepassing is.
• httpOnly
  • Als deze cookie alleen geldig is wanneer de website wordt bekeken met het HTTP-protocol.
• expires
  • De datum waarop deze cookie vervalt
• type
  • Het type cookie dat dit is, kan een van de volgende zijn:
    • Wereldwijd - dit is een wereldwijd cookie ingesteld door GrabzIt
    • Lokaal - dit is een door u ingesteld lokaal cookie
    • Overschreven - een globale cookie die door u is overschreven

ScreenShotStatus

De klasse die de huidige status van de schermafbeelding weergeeft.

Publieke eigenschappen

• processing
  • Indien waar wordt de screenshot nog steeds verwerkt.
• cached
  • Indien true is de screenshot is verwerkt en wordt deze in de cache opgeslagen.
• expired
  • Indien waar is de screenshot niet langer op het GrabzIt-systeem.
• message
  • Een foutmelding geretourneerd door het systeem.

WaterMark

Deze klasse vertegenwoordigt de aangepaste watermerken die zijn opgeslagen in GrabzIt

Publieke eigenschappen

• identifier
  • De identificatie van het watermerk
• xPosition
  • De horizontale positie van het watermerk
    • Links = 0
    • Midden = 1
    • Rechts = 2
• yPosition
  • De verticale positie van het watermerk
    • Boven = 0
    • Midden = 1
    • Onder = 2
• format
  • Het formaat van het watermerk