Tools zum Erfassen und Konvertieren des Webs

GrabzItClient mit JavaJava API

Beschreibung

Diese Klasse verwaltet die gesamte Kommunikation mit den GrabzIt-Screenshot-Webdiensten.

├ľffentliche Methoden

GrabzItFile GetResult(String Ich w├╝rde)

Diese Methode gibt den Screenshot selbst zur├╝ck. Wenn nichts zur├╝ckgegeben wird, ist ein Fehler aufgetreten oder der Screenshot ist noch nicht fertig.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich

R├╝ckgabewert

GrabzItFile Objekt


URLToAnimation(String url, AnimationOptions Optionen)

Geben Sie die URL des Online-Videos an, das konvertiert werden soll into ein animiertes GIF.

Parameter

  • url - Die URL des zu konvertierenden Online-Videos into ein animiertes GIF.
    • Erforderlich
    • Akzeptiert Vimeo- und YouTube-Video-URLs
      • Die Warnung, dass Vimeo- und YouTube-Videos animiert werden m├╝ssen, h├Ąngt von Dritten ab und liefert m├Âglicherweise keine konsistenten Ergebnisse.
  • Optionen - eine Instanz der AnimationOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des animierten GIF verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

AnimationOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen eines animierten GIF zur Verf├╝gung stehen.

├ľffentliche Eigenschaften

  • setCustomId(String value) - Benutzerdefinierte Kennung, die Sie an den animierten GIF-Webdienst ├╝bergeben k├Ânnen. Dies wird mit der von Ihnen angegebenen R├╝ckruf-URL zur├╝ckgegeben.
    • Voreinstellung: leer
  • setWidth(int value) - die Breite des resultierenden animierten GIF in Pixel.
    • Standard: 180px
    • Maximum: Maximale Breite f├╝r das Paket
    • Automatische Gr├Â├če: -1 (├ťbergabe von -1 bedeutet, dass die Breite des animiertes GIF wird skaliert In Bezug auf die H├Âhe kann die H├Âhe nicht angepasst werden, wenn die Breite automatisch angepasst wird.
  • setHeight(int value) - Die H├Âhe des resultierenden animierten GIF in Pixel.
    • Standard: 120px
    • Maximum: Maximale H├Âhe f├╝r das Paket
    • Automatische Gr├Â├če: -1 (├ťbergabe von -1 bedeutet, dass die H├Âhe des animiertes GIF wird skaliert in Bezug auf die Breite, wenn die H├Âhe automatisch angepasst wird, kann die Breite nicht)
  • setStart(int value) - Die Startposition des Videos, das konvertiert werden soll into ein animiertes GIF.
    • Voreinstellung: 0 Sekunden
  • setDuration(int value) - Die L├Ąnge des zu konvertierenden Videos in Sekunden into ein animiertes GIF.
    • Standard: maximale L├Ąnge f├╝r das Paket
  • setSpeed(float value) - die Geschwindigkeit des animierten GIF.
    • Standard: 1
    • Minimum: 0.2
    • Maximum: 10
  • setFramesPerSecond(float value) - Die Anzahl der Bilder pro Sekunde, die aus dem Video aufgenommen werden sollen.
    • Standard: 10
    • Minimum: 0.2
    • Maximum: 60
  • setRepeat(int value) - H├Ąufigkeit, mit der das animierte GIF wiederholt wird.
    • Standard: 0
    • Endlosschleife: 0
  • setReverse(boolean value) - Wenn true, werden die Frames des animierten GIF umgekehrt
    • Voreinstellung: false
  • setCustomWaterMarkId(String value) - F├╝gen Sie dem animierten GIF ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • setQuality(int value) - das Qualit├Ąt des zur├╝ckgegebenen Bildes, die eine Standardkomprimierung von 85% hat.
    • Durch Verringern der Qualit├Ąt wird die Dateigr├Â├če verringert und die Downloadzeit verk├╝rzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • setCountry(Country value) - das Land Das animierte GIF sollte entnommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Zubeh├Âr: Land.SINGAPUR, Land.GROSSBRITANNIEN, Land.VEREINIGTE STAATEN
  • setExportURL(String value) - das URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • setEncryptionKey(String key) - Wenn ein Basis-64-codierter AES-Verschl├╝sselungsschl├╝ssel angegeben ist, wird Ihr Capture beim Erstellen verschl├╝sselt. Es wird empfohlen, die zu verwenden Verschl├╝sselungsmethode erstellen den Schl├╝ssel und die Methoden entschl├╝sseln um das verschl├╝sselte Capture wie in gezeigt zu entschl├╝sseln Dieses Beispiel.
    • Voreinstellung: leer
  • setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

URLToImage(String url, ImageOptions Optionen)

Gibt die URL an, die konvertiert werden soll into ein Bild Screenshot.

Parameter

  • url - die URL, aus der der Screenshot bestehen soll
    • Erforderlich
  • Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des Screenshots verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

HTMLToImage(String html, ImageOptions Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into ein Bild.

Parameter

  • html - das zu konvertierende HTML into ein Bild
    • Erforderlich
  • Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

FileToImage(String Pfad, ImageOptions Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein Bild.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein Bild
    • Erforderlich
  • Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

ImageOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von Bilderfassungen verf├╝gbar sind.

├ľffentliche Eigenschaften

  • setCustomId(String value) - Benutzerdefinierte Kennung, die Sie an den Screenshot-Webservice ├╝bergeben k├Ânnen. Dies wird mit der von Ihnen angegebenen R├╝ckruf-URL zur├╝ckgegeben.
    • Voreinstellung: leer
  • setBrowserWidth(int value) - die Breite des Browsers in Pixel
    • Standard: 1024
    • Maximum: 10000
  • setBrowserHeight(int value) - die H├Âhe des Browsers in Pixel
    • Standard: 768
    • Maximum: 10000
    • Volle L├Ąnge: -1 (Die ├ťbergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
  • setWidth(int value) - die Breite des resultierenden Thumbnails in Pixel
    • Standard: Das h├Âchstm├Âgliche Verh├Ąltnis der Browserbreite, das in die maximale Breite des Benutzerpakets passt
    • Maximum: Maximale Breite f├╝r das Paket
    • Volle Breite: -1 (Das ├ťbergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
  • setHeight(int value) - Die H├Âhe des resultierenden Thumbnails in Pixel
    • Standard: Das h├Âchstm├Âgliche Verh├Ąltnis der Browserh├Âhe, das in die maximale H├Âhe des Benutzerpakets passt
    • Maximum: Maximale H├Âhe f├╝r das Paket
    • Volle H├Âhe: -1 (Das ├ťbergeben von -1 bedeutet, dass die H├Âhe des Thumbnails nicht verringert wird.)
  • setFormat(ImageFormat value) - Das Format, in dem der Screenshot angezeigt werden soll.
  • setDelay(int value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • setTargetElement(String value) - die ID oder Klasse CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intAls Screenshot werden alle anderen Teile der Webseite ignoriert. Wenn mehrere ├╝bereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgew├Ąhlt
    • Voreinstellung: leer
  • setHideElement(String value) - die ID oder Klasse CSS-Selektoren Wenn Sie festlegen m├Âchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • setWaitForElement(String value) - die ID oder Klasse CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgef├╝hrt wird
    • Voreinstellung: leer
  • setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden m├Âchten
  • setCustomWaterMarkId(String value) - F├╝gen Sie dem Bild ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • setQuality(int value) - das Qualit├Ąt des zur├╝ckgegebenen Bildes. Dies betrifft derzeit nur JPG-Bilder mit einer Standardkomprimierung von 85%.
    • Durch Verringern der Qualit├Ąt wird die Dateigr├Â├če verringert und die Downloadzeit verk├╝rzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • setTransparent(boolean value) - Wenn das stimmt Die Bildaufnahme sollte transparent sein. Dies ist nur mit PNG- und TIFF-Bildern kompatibel.
    • Voreinstellung: false
  • setHd(boolean value) - Wenn das Bild wahr ist Die Aufnahme erfolgt in High Definition Dies verdoppelt die Gr├Â├če der Bildabmessungen.
    • Voreinstellung: false
  • setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Zubeh├Âr: Land.SINGAPUR, Land.GROSSBRITANNIEN, Land.VEREINIGTE STAATEN
  • setExportURL(String value) - das URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • setEncryptionKey(String key) - Wenn ein Basis-64-codierter AES-Verschl├╝sselungsschl├╝ssel angegeben ist, wird Ihr Capture beim Erstellen verschl├╝sselt. Es wird empfohlen, die zu verwenden Verschl├╝sselungsmethode erstellen den Schl├╝ssel und die Methoden entschl├╝sseln um das verschl├╝sselte Capture wie in gezeigt zu entschl├╝sseln Dieses Beispiel.
    • Voreinstellung: leer
  • setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle h├Ąufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setAddress(String address) - Die URL, unter der der HTML-Code ausgef├╝hrt werden soll. Kann n├╝tzlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs f├╝r Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

├ľffentliche Methoden

  • AddPostParameter (String Name, String Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen. Mit dieser Methode wird GrabzIt auf erzwungen F├╝hren Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

URLToRenderedHTML(String url, HTMLOptions Optionen)

Gibt die URL an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • url - die URL, aus der das gerenderte HTML bestehen soll
    • Erforderlich
  • Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des gerenderten HTML-Codes verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

HTMLToRenderedHTML(string html, HTMLOptions Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into gerendertes HTML.

Parameter

  • html - das zu konvertierende HTML into gerendertes HTML
  • Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

FileToRenderedHTML(string Pfad, HTMLOptions Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into gerendertes HTML
    • Erforderlich
  • Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

HTMLOptions

Die Klasse stellt alle verf├╝gbaren Optionen dar, wenn Erstellen von gerenderten HTML-Captures.

├ľffentliche Eigenschaften

├ľffentliche Methoden

  • AddPostParameter (String Name, String Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen. Mit dieser Methode wird GrabzIt auf erzwungen F├╝hren Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

URLToPDF(String url, PDFOptions Optionen)

Gibt die URL an, die konvertiert werden soll into ein PDF.

Parameter

  • url - die URL, die konvertiert werden soll into ein PDF
    • Erforderlich
  • PDFOptions options - Eine Instanz der PDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

HTMLToPDF(String html, PDFOptions Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into ein PDF.

Parameter

  • html - das zu konvertierende HTML into ein PDF
    • Erforderlich
  • PDFOptions options - Eine Instanz der PDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

FileToPDF(String Pfad, PDFOptions Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein PDF.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein PDF
    • Erforderlich
  • PDFOptions options - Eine Instanz der PDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

PDFOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von PDF-Captures verf├╝gbar sind.

├ľffentliche Eigenschaften

  • setCustomId(String value) - eine benutzerdefinierte Kennung, die Sie an den Webservice ├╝bergeben k├Ânnen. Dies wird mit der von Ihnen angegebenen R├╝ckruf-URL zur├╝ckgegeben.
    • Voreinstellung: leer
  • setIncludeBackground(boolean value) - Wenn dies zutrifft, sollte der Hintergrund der Webseite im Screenshot enthalten sein
    • Voreinstellung: true
  • setPageSize(PageSize value) - die Seitengr├Â├če des PDF
  • setOrientation(PageOrientation value) - die Ausrichtung des PDF-Dokuments
  • setCSSMediaType(CSSMediaType value) - das CSS-Medientyp des PDF-Dokuments
  • setIncludeLinks(boolean value) - true, wenn Links in das PDF aufgenommen werden sollen
    • Voreinstellung: true
  • setIncludeOutline(boolean value) - wahr wenn PDF Lesezeichen das sollte dabei sein
    • Voreinstellung: false
  • setTitle(String value) - Geben Sie dem PDF-Dokument einen Titel
    • Voreinstellung: leer
  • setCoverURL(string value) - Die URL einer Webseite, die als Deckblatt f├╝r das PDF verwendet werden soll
    • Voreinstellung: leer
  • setMarginTop(int value) - Der Rand in Millimetern, der oben auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginLeft(int value) - Der Rand in Millimetern, der links auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginBottom(int value) - Der Rand in Millimetern, der am unteren Rand der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginRight(int value) - Der Rand in Millimetern, der rechts vom PDF-Dokument angezeigt werden soll
    • Standard: 10
  • setBrowserWidth(int value) - die ... Die Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (├ťbergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des PDF-Dokuments ├╝bereinstimmt.)
  • setPageWidth(int value) - das benutzerdefinierte Breite der resultierenden PDF in mm
  • setPageHeight(int value) - das Benutzerdefinierte H├Âhe der resultierenden PDF in mm
    • Standard: PageSize H├Âhe
    • Minimum: 15
  • setDelay(int value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden m├Âchten
  • setTemplateId(String value) - f├╝ge hinzu ein Vorlage ID, die die Kopf- und Fu├čzeile des PDF-Dokuments angibt
    • Voreinstellung: leer
  • setTargetElement(String value) - die ID oder Klasse CSS-Selektor der einzige HTML-Element auf der Zielwebseite, die gedreht werden soll into ein PDFwerden alle anderen Teile der Webseite ignoriert. Wenn mehrere ├╝bereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgew├Ąhlt
    • Voreinstellung: leer
  • setHideElement(String value) - die ID oder Klasse CSS-Selektoren Wenn Sie festlegen m├Âchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • setWaitForElement(String value) - die ID oder Klasse CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgef├╝hrt wird
    • Voreinstellung: leer
  • setCustomWaterMarkId(String value) - F├╝gen Sie jeder Seite des PDF-Dokuments ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • setQuality(int value) - das Qualit├Ąt der zur├╝ckgegebenen PDF. Die Standardeinstellung verwendet die empfohlene Qualit├Ąt f├╝r das PDF.
    • Durch Verringern der Qualit├Ąt wird die Dateigr├Â├če verringert und die Downloadzeit verk├╝rzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Zubeh├Âr: Land.SINGAPUR, Land.GROSSBRITANNIEN, Land.VEREINIGTE STAATEN
  • setExportURL(String value) - das URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • setEncryptionKey(String key) - Wenn ein Basis-64-codierter AES-Verschl├╝sselungsschl├╝ssel angegeben ist, wird Ihr Capture beim Erstellen verschl├╝sselt. Es wird empfohlen, die zu verwenden Verschl├╝sselungsmethode erstellen den Schl├╝ssel und die Methoden entschl├╝sseln um das verschl├╝sselte Capture wie in gezeigt zu entschl├╝sseln Dieses Beispiel.
    • Voreinstellung: leer
  • setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle h├Ąufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setAddress(String address) - Die URL, unter der der HTML-Code ausgef├╝hrt werden soll. Kann n├╝tzlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs f├╝r Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • setMergeId(String mergeId) - die ID eines Captures, das sein soll am Anfang des neuen PDF-Dokuments zusammengef├╝hrt
    • Voreinstellung: leer
  • setPassword(String password) - das Passwort zum Schutz des PDF-Dokuments mit
    • Voreinstellung: leer

├ľffentliche Methoden

  • AddPostParameter (String Name, String Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen. Mit dieser Methode wird GrabzIt auf erzwungen F├╝hren Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters
  • AddTemplateParameter (String Name, String Wert) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen.
    • name - Der Name des Vorlagenparameters
    • value - Der Wert des Vorlagenparameters

URLToDOCX (String url, DOCXOptions Optionen)

Gibt die URL an, die konvertiert werden soll intoa DOCX.

Parameter

  • url - die URL, die konvertiert werden soll intoa DOCX
    • Erforderlich
  • DOCXOptions options - eine Instanz der DOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

HTMLToDOCX(String html, DOCXOptions Optionen)

Gibt den HTML-Code an, der konvertiert werden soll intoa DOCX.

Parameter

  • html - das zu konvertierende HTML intoa DOCX
    • Erforderlich
  • DOCXOptions options - eine Instanz der DOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

FileToDOCX(String Pfad, DOCXOptions Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll intoa DOCX.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei intoa DOCX
    • Erforderlich
  • DOCXOptions options - eine Instanz der DOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

R├╝ckgabewert

ung├╝ltig

DOCXOptions

Die Klasse stellt alle Optionen dar, die beim Erstellen von DOCX-Captures verf├╝gbar sind.

├ľffentliche Eigenschaften

  • setCustomId(String value) - eine benutzerdefinierte Kennung, die Sie an den Webservice ├╝bergeben k├Ânnen. Dies wird mit der von Ihnen angegebenen R├╝ckruf-URL zur├╝ckgegeben.
    • Voreinstellung: leer
  • setIncludeBackground(boolean value) - Wenn dies zutrifft, sollten die Hintergrundbilder der Webseite in die DOCX aufgenommen werden
    • Voreinstellung: true
  • setPageSize(PageSize value) - die Seitengr├Â├če des DOCX
  • setOrientation(PageOrientation value) - die Ausrichtung des DOCX-Dokuments
  • setIncludeLinks(boolean value) - true, wenn Links in die DOCX aufgenommen werden sollen
    • Voreinstellung: true
  • setIncludeImages(boolean value) - Wenn dies zutrifft, sollten die Bilder der Webseite in die DOCX aufgenommen werden
    • Voreinstellung: true
  • setTitle(String value) - Geben Sie dem DOCX-Dokument einen Titel
    • Voreinstellung: leer
  • setMarginTop(int value) - Der Rand in Millimetern, der oben auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginLeft(int value) - Der Rand in Millimetern, der links auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginBottom(int value) - Der Rand in Millimetern, der am unteren Rand der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • setMarginRight(int value) - der Rand in Millimetern, der rechts vom DOCX-Dokument angezeigt werden soll
    • Standard: 10
  • setBrowserWidth(int value) - das Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (├ťbergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des PDF-Dokuments ├╝bereinstimmt.)
  • setPageWidth(int value) - das benutzerdefinierte Breite des resultierenden DOCX in mm
  • setPageHeight(int value) - das benutzerdefinierte H├Âhe des resultierenden DOCX in mm
    • Standard: PageSize H├Âhe
    • Minimum: 15
  • setDelay(int value) - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden m├Âchten
  • setTemplateId(String value) - f├╝ge hinzu ein Vorlage ID, die die Kopf- und Fu├čzeile des DOCX-Dokuments angibt
    • Voreinstellung: leer
  • setTargetElement(String value) - die ID oder Klasse CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intAls Screenshot werden alle anderen Teile der Webseite ignoriert. Wenn mehrere ├╝bereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgew├Ąhlt
    • Voreinstellung: leer
  • setHideElement(String value) - die ID oder Klasse CSS-Selektoren Wenn Sie festlegen m├Âchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
    • Voreinstellung: leer
  • setWaitForElement(String value) - die ID oder Klasse CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgef├╝hrt wird
    • Voreinstellung: leer
  • setQuality(int value) - das Qualit├Ąt des zur├╝ckgesandten DOCX. Die Standardeinstellung verwendet die empfohlene Qualit├Ąt f├╝r die DOCX.
    • Durch Verringern der Qualit├Ąt wird die Dateigr├Â├če verringert und die Downloadzeit verk├╝rzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Zubeh├Âr: Land.SINGAPUR, Land.GROSSBRITANNIEN, Land.VEREINIGTE STAATEN
  • setExportURL(String value) - das URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • setEncryptionKey(String key) - Wenn ein Basis-64-codierter AES-Verschl├╝sselungsschl├╝ssel angegeben ist, wird Ihr Capture beim Erstellen verschl├╝sselt. Es wird empfohlen, die zu verwenden Verschl├╝sselungsmethode erstellen den Schl├╝ssel und die Methoden entschl├╝sseln um das verschl├╝sselte Capture wie in gezeigt zu entschl├╝sseln Dieses Beispiel.
    • Voreinstellung: leer
  • setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle h├Ąufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • setAddress(String address) - Die URL, unter der der HTML-Code ausgef├╝hrt werden soll. Kann n├╝tzlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs f├╝r Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • setMergeId(String mergeId) - die ID eines Captures, das sein soll am Anfang des neuen DOCX-Dokuments zusammengef├╝hrt
    • Voreinstellung: leer
  • setPassword(String mergeId) - das Passwort zum Schutz des DOCX-Dokuments mit
    • Voreinstellung: leer

├ľffentliche Methoden

  • AddPostParameter (String Name, String Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen. Mit dieser Methode wird GrabzIt auf erzwungen F├╝hren Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters
  • AddTemplateParameter (String Name, String Wert) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen.
    • name - Der Name des Vorlagenparameters
    • value - Der Wert des Vorlagenparameters

URLToTable(String url, TableOptions Optionen)

Gibt die URL an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • url - die URL, aus der HTML-Tabellen extrahiert werden sollen
    • Erforderlich
  • TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen f├╝r die Konvertierung der HTML-Tabelle definiert.

R├╝ckgabewert

ung├╝ltig

HTMLToTable (String html, TableOptions Optionen)

Gibt den HTML-Code an, aus dem die HTML-Tabellen extrahiert werden sollen.

Parameter

  • html - das HTML, aus dem HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen f├╝r die Konvertierung der HTML-Tabelle definiert.

R├╝ckgabewert

ung├╝ltig

FileToTable (String Pfad, TableOptions Optionen)

Gibt eine HTML-Datei an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • path - Der Dateipfad einer HTML-Datei, aus der HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen f├╝r die Konvertierung der HTML-Tabelle definiert.

R├╝ckgabewert

ung├╝ltig

TableOptions

Die Klasse stellt alle Optionen dar, die beim Konvertieren von HTML-Tabellen in CSV, XLSX oder JSON verf├╝gbar sind.

├ľffentliche Eigenschaften

  • setCustomId(String value) - eine benutzerdefinierte Kennung, die Sie an den Webservice ├╝bergeben k├Ânnen. Dies wird mit der von Ihnen angegebenen R├╝ckruf-URL zur├╝ckgegeben
    • Voreinstellung: leer
  • setTableNumberToInclude(int value) - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
    • Standard: 1
  • setFormat(TableFormat value) - das Format, in dem die Tabelle sein soll
  • setIncludeHeaderNames(boolean value) - ob echte Headernamen in die Tabelle aufgenommen werden
    • Voreinstellung: true
  • setIncludeAllTables(boolean value) - Wenn true, werden alle Tabellen auf der Webseite extrahiert, wobei jede Tabelle in einem separaten Arbeitsblatt angezeigt wird. Nur im XLSX-Format verf├╝gbar
    • Voreinstellung: false
  • setTargetElement(String value) - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
    • Voreinstellung: leer
  • setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden m├Âchten
  • setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert m├Âglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Zubeh├Âr: Land.SINGAPUR, Land.GROSSBRITANNIEN, Land.VEREINIGTE STAATEN
  • setExportURL(String value) - das URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • setEncryptionKey(String key) - Wenn ein Basis-64-codierter AES-Verschl├╝sselungsschl├╝ssel angegeben ist, wird Ihr Capture beim Erstellen verschl├╝sselt. Es wird empfohlen, die zu verwenden Verschl├╝sselungsmethode erstellen den Schl├╝ssel und die Methoden entschl├╝sseln um das verschl├╝sselte Capture wie in gezeigt zu entschl├╝sseln Dieses Beispiel.
    • Voreinstellung: leer
  • setAddress(String address) - Die URL, unter der der HTML-Code ausgef├╝hrt werden soll. Kann n├╝tzlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs f├╝r Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

├ľffentliche Methoden

  • AddPostParameter (String Name, String Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzuf├╝gen. Mit dieser Methode wird GrabzIt auf erzwungen F├╝hren Sie einen HTTP-Post durch.
    • name - Der Name des HTTP-Post-Parameters
    • value - Der Wert des HTTP-Post-Parameters

Save()

Save das Ergebnis asynchron und gibt eine eindeutige Kennung zur├╝ck, mit der der Screenshot mit dem abgerufen werden kann GetResult Methode.

R├╝ckgabewert

Andernfalls wird die eindeutige Kennung des Screenshots ausgel├Âst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit dem zu erhalten GetResult Methode


Dies ist die empfohlene Methode zum Speichern einer Datei

Save(String callBackURL)

Save das Ergebnis asynchron und gibt eine eindeutige Kennung zur├╝ck, mit der der Screenshot mit dem abgerufen werden kann GetResult Methode.

Parameter

  • callBackURL - die Handler Der GrabzIt-Dienst sollte anrufen, nachdem er seine Arbeit abgeschlossen hat
    • Erforderlich

R├╝ckgabewert

Andernfalls wird die eindeutige Kennung des Screenshots ausgel├Âst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit dem zu erhalten GetResult Methode

Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, w├Ąhrend das Ergebnis verarbeitet wird

GrabzItFile SaveTo()

Save das Ergebnis synchron zu a GrabzItFile Objekt.

R├╝ckgabewert

GrabzItFile Objekt


Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, w├Ąhrend das Ergebnis verarbeitet wird

SaveTo(String saveEinordnen)

Save das Ergebnis synchron zu einer Datei.

Parameter

  • saveToFile - der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
    • Erforderlich

R├╝ckgabewert

Gibt true zur├╝ck, wenn es erfolgreich ist, andernfalls wird eine Ausnahme ausgel├Âst.


Kategorie Status bekommen(String Ich w├╝rde)

Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich

R├╝ckgabewert

Kategorie Objekt


GrabzItCookie [] GetCookies (String Domain)

Holen Sie sich alle Cookies, die GrabzIt f├╝r eine bestimmte Domain verwendet. Dies kann auch benutzerdefinierte Cookies beinhalten.

Parameter

  • domain - Die Domain, f├╝r die Cookies zur├╝ckgegeben werden sollen
    • Erforderlich

R├╝ckgabewert

GrabzItCookie Feld


SetCookie (String Name, String Domain, String Wert, String Pfad, boolean httponly, Datum l├Ąuft ab)

Legt ein neues benutzerdefiniertes Cookie f├╝r GrabzIt fest. Wenn das benutzerdefinierte Cookie denselben Namen und dieselbe Dom├Ąne wie ein globales Cookie hat, wird das globale Cookie ├╝berschrieben.

Dies kann hilfreich sein, wenn die Funktionalit├Ąt einer Website durch Cookies gesteuert wird.

Parameter

  • name - Der Name des zu setzenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, f├╝r die das Cookie festgelegt werden soll
    • Erforderlich
  • value - der Wert des Cookies
  • Pfad - Der Website-Pfad, auf den sich das Cookie bezieht
  • httponly - Wenn dies zutrifft, kann der Cookie nur mit dem HTTP-Protokoll verwendet werden
  • abl├Ąuft - Legt fest, wann der Cookie abl├Ąuft. ├ťbergeben Sie einen Nullwert, wenn das Cookie nicht ablaufen soll

R├╝ckgabewert

True, wenn das Cookie erfolgreich gesetzt wurde, andernfalls false


DeleteCookie (String Name, String Domain)

L├Âschen Sie ein benutzerdefiniertes Cookie oder blockieren Sie die Verwendung eines globalen Cookies

Parameter

  • name - Der Name des zu l├Âschenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, f├╝r die das Cookie gel├Âscht werden soll
    • Erforderlich

R├╝ckgabewert

True, wenn der Cookie erfolgreich gel├Âscht wurde, andernfalls false


WaterMark[] ErhalteWaterMarks()

Holen Sie sich alle Ihre hochgeladenen benutzerdefinierten Wasserzeichen

R├╝ckgabewert

WaterMark Feld


WaterMark ErhalteWaterMark(String Kennung)

Geben Sie Ihre benutzerdefinierten Wasserzeichen zur├╝ck, die der angegebenen Kennung entsprechen

Parameter

  • bezeichner - Der Bezeichner eines bestimmten benutzerdefinierten Wasserzeichens, das Sie anzeigen m├Âchten
    • Erforderlich

R├╝ckgabewert

WaterMark Objekt


AddWaterMark(String Kennung, String Pfad, HorizontalPosition xpos, VerticalPosition ypos)

F├╝gen Sie ein neues benutzerdefiniertes Wasserzeichen hinzu

Parameter

  • bezeichner - der Bezeichner, dem Sie das benutzerdefinierte Wasserzeichen geben m├Âchten. Es ist wichtig, dass diese Kennung eindeutig ist.
    • Erforderlich
  • Pfad - der absolute Pfad des Wasserzeichens auf Ihrem Server. Zum Beispiel C: /watermark/1.png
    • Erforderlich
  • xpos - Die horizontale Position, an der der Screenshot angezeigt werden soll
  • ypos - vertikale Position, an der der Screenshot angezeigt werden soll

R├╝ckgabewert

Gibt true zur├╝ck, wenn das Wasserzeichen erfolgreich gesetzt wurde


DeleteWaterMark(String Kennung)

L├Âschen Sie ein benutzerdefiniertes Wasserzeichen

Parameter

  • bezeichner - Der Bezeichner des benutzerdefinierten Wasserzeichens, das Sie l├Âschen m├Âchten
    • Erforderlich

R├╝ckgabewert

Gibt true zur├╝ck, wenn das Wasserzeichen erfolgreich gel├Âscht wurde


SetLocalProxy (String proxyUrl)

Diese Methode erm├Âglicht a lokaler Proxy-Server f├╝r alle Anfragen zu verwenden.

Parameter

  • proxyUrl - Die URL des Proxys, die bei Bedarf einen Port enthalten kann. Wenn Sie eine Null angeben, werden alle zuvor festgelegten Proxys entfernt
    • Erforderlich

UseSSL (boolean value)

Gibt an, ob Anfragen an GrabzIt gesendet werden sollen API sollte SSL verwenden

Parameter

  • value - Wenn true, verwenden alle Anforderungen an die GrabzIt-API SSL
    • Erforderlich

String CreateEncryptionKey ()

Erstellen Sie einen kryptografisch sicheren Basis-64-Verschl├╝sselungsschl├╝ssel mit 44-Zeichen.


Entschl├╝sseln (String Pfad, String Schl├╝ssel)

Entschl├╝sseln Sie ein verschl├╝sseltes Capture mit dem angegebenen Verschl├╝sselungsschl├╝ssel.

Parameter


GrabzItFile Entschl├╝sseln (GrabzItFile Datei, String Schl├╝ssel)

Entschl├╝sseln Sie ein verschl├╝sseltes Capture mit dem angegebenen Verschl├╝sselungsschl├╝ssel.

Parameter


Byte [] Entschl├╝sseln (Byte [] Daten, String Schl├╝ssel)

Entschl├╝sseln Sie ein verschl├╝sseltes Capture mit dem angegebenen Verschl├╝sselungsschl├╝ssel.

Parameter


Enums

ImageFormat

Diese Aufz├Ąhlung umfasst die folgenden Werte.

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

BrowserType

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • STANDARDBROWSER
  • MOBILEBROWSER
  • SUCHMASCHINE
  • FALLBACKBROWSER

Land

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • DEFAULT
  • SINGAPUR
  • GROSSBRITANNIEN
  • VEREINIGTE STAATEN

PageSize

Diese Aufz├Ąhlung umfasst die folgenden Werte.

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

PageOrientation

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • LANDSCHAFT
  • PORTRAIT

CSSMediaType

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • DRUCKEN
  • SCREEN

TableFormat

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • CSV
  • JSON
  • XSLX

HorizontalPosition

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • LINKS
  • STADTZENTRUM
  • RECHTS

VerticalPosition

Diese Aufz├Ąhlung umfasst die folgenden Werte.

  • TOP
  • MITTEL
  • UNTEN

Ergebnisklassen

Cookies

├ľffentliche Eigenschaften

  • String getName()
    • Der Cookie-Name.
  • String getValue()
    • Der Cookie-Wert.
  • String getDomain()
    • Die Domain, f├╝r die das Cookie gesetzt ist.
  • String getPath()
    • Der Pfad in der Dom├Ąne, f├╝r die dieses Cookie gilt.
  • String getHttpOnly()
    • Wenn dieses Cookie nur g├╝ltig ist, wenn die Website mit dem HTTP-Protokoll angezeigt wird.
  • String getExpires()
    • Das Datum, an dem dieses Cookie abl├Ąuft
  • String getType()
    • Hierbei handelt es sich um einen der folgenden Cookie-Typen:
      • Global - Dies ist ein globales Cookie, das von GrabzIt gesetzt wird
      • Lokal - Dies ist ein von Ihnen festgelegtes lokales Cookie
      • ├ťberschrieben - Ein globales Cookie, das von Ihnen ├╝berschrieben wurde

GrabzItFile

├ľffentliche Methoden

  • byte [] getBytes ()
  • ung├╝ltig Save(String Pfad)
  • String zuString()

Kategorie

Die Klasse, die den aktuellen Status des Screenshots darstellt.

├ľffentliche Methoden

  • boolean isProcessing ()
    • Wenn true, wird der Screenshot noch verarbeitet.
  • boolean isCached ()
    • Wenn true, wurde der Screenshot verarbeitet und ist derzeit im Cache.
  • boolean isExpired ()
    • Wenn dies zutrifft, befindet sich der Screenshot nicht mehr auf dem GrabzIt-System.
  • String getMessage ()
    • Eine vom System zur├╝ckgegebene Fehlermeldung.

WaterMark

Diese Klasse repr├Ąsentiert die in GrabzIt gespeicherten benutzerdefinierten Wasserzeichen

├ľffentliche Methoden