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) - der 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der benutzerdefinierte Breite der resultierenden PDF in mm
  • setPageHeight(int value) - der Benutzerdefinierte Höhe der resultierenden PDF in mm
  • 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der 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) - der benutzerdefinierte Breite des resultierenden DOCX in mm
  • setPageHeight(int value) - der benutzerdefinierte Höhe des resultierenden DOCX in mm
  • 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) - der 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) - der 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) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • setQuality(int value) - der 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) - der 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) - der 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) - der 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[] BezahlungWaterMarks()

Holen Sie sich alle Ihre hochgeladenen benutzerdefinierten Wasserzeichen

Rückgabewert

WaterMark Feld


WaterMark BezahlungWaterMark(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


Verwenden SieWaterMark(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
  • Rechtliches
  • 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.

  • NACH OBEN
  • 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