Beschreibung
Diese Klasse verwaltet die gesamte Kommunikation mit den GrabzIt-Screenshot-Webdiensten.
Öffentliche Methoden
- GrabzItFile GetResult(String id)
- URLToAnimation(String url, AnimationOptions options)
- URLToImage(String url, ImageOptions options)
- HTMLToImage(String html, ImageOptions options)
- FileToImage(String path, ImageOptions options)
- URLToPDF(String url, PDFOptions options)
- HTMLToPDF(String html, PDFOptions options)
- FileToPDF(String path, PDFOptions options)
- URLToDOCX(String url, DOCXOptions options)
- HTMLToDOCX(String html, DOCXOptions options)
- FileToDOCX(String path, DOCXOptions options)
- URLToTable(String url, TableOptions options)
- HTMLToTable(String html, TableOptions options)
- FileToTable(String path, TableOptions options)
- URLToRenderedHTML(String url, HTMLOptions options)
- HTMLToRenderedHTML(String html, HTMLOptions options)
- FileToRenderedHTML(String path, HTMLOptions options)
- String Save()
- String Save(String callBackURL)
- GrabzItFile SaveTo()
- boolean SaveTo(String saveToFile)
- Status GetStatus(String id)
- GrabzItCookie[] GetCookies(String domain)
- boolean SetCookie(String name, String domain, String value, String path, boolean httponly, Date? expires)
- boolean DeleteCookie(String name, String domain)
- WaterMark[] GetWaterMarks()
- WaterMark GetWaterMark(String identifier)
- boolean AddWaterMark(String identifier, String path, HorizontalPosition xpos, VerticalPosition ypos)
- boolean DeleteWaterMark(String identifier)
- SetLocalProxy(String proxyUrl)
- UseSSL(boolean value)
- String CreateEncryptionKey()
- Decrypt(String path, String key)
- GrabzItFile Decrypt(GrabzItFile file, String key)
- byte[] Decrypt(byte[] data, String key)
GrabzItFile GetResult(String 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
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.
-
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
- Schleife nie: -1
-
setReverse(boolean value) - Wenn true, werden die Frames des animierten GIF umgekehrt
-
setCustomWaterMarkId(String value) - Benutzerdefiniert hinzufügen watermark zum animierten GIF
-
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.
- 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
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
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
- 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
- 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
- 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.
-
setBrowserWidth(int value) - die Breite des Browsers in Pixel
- Standard: 1366
- Maximum: 10000
-
setBrowserHeight(int value) - die Höhe des Browsers in Pixel
- Standard: 1170
- Maximum: 10000
- Volle Länge: -1 (Die Übergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
-
setOutputWidth(int value) - die Breite des resultierenden Thumbnails in Pixel
- Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabehöhe angegeben wird, ist die Ausgabebreite proportional zur Ausgabehöhe
- Maximum: Maximale Breite für das Paket
- Volle Breite: -1 (Das Übergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
-
setOutputHeight(int value) - Die Höhe des resultierenden Thumbnails in Pixel
- Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabebreite angegeben wird, ist die Ausgabehöhe proportional zur Ausgabebreite
- 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
-
setClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
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
-
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
-
setWaitForElement(String value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden möchten
-
setCustomWaterMarkId(String value) - Fügen Sie eine benutzerdefinierte watermark zum Bild
-
setQuality(int value) - der Qualität des zurückgegebenen Bildes. Dies betrifft derzeit nur JPG- und WEBP-Bilder mit einer Standardkomprimierung von 90%.
- 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.
-
setHd(boolean value) - Wenn das Bild wahr ist Die Aufnahme erfolgt in High Definition Dies verdoppelt die Größe der Bildabmessungen.
-
setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
- 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
-
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.
-
setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Ö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
-
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
-
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
-
setCustomId(String value) - Benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
setBrowserWidth(int value) - die Breite des Browsers in Pixel
- Standard: 1366
- Maximum: 10000
-
setBrowserHeight(int value) - die Höhe des Browsers in Pixel
- Standard: 1170
- Maximum: 10000
-
setWaitForElement(String value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden möchten
-
setExportURL(String value) - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
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.
-
setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Ö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
- 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
- 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
- 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.
-
setIncludeBackground(boolean value) - Wenn dies zutrifft, sollte der Hintergrund der Webseite im Screenshot enthalten sein
-
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
-
setIncludeOutline(boolean value) - wahr wenn PDF Lesezeichen das sollte dabei sein
-
setTitle(String value) - Geben Sie dem PDF-Dokument einen Titel
-
setCoverURL(string value) - Die URL einer Webseite, die als Deckblatt für das PDF verwendet werden soll
-
setMarginTop(int value) - Der Rand in Millimetern, der oben auf der PDF-Dokumentseite angezeigt werden soll
-
setMarginLeft(int value) - Der Rand in Millimetern, der links auf der PDF-Dokumentseite angezeigt werden soll
-
setMarginBottom(int value) - Der Rand in Millimetern, der am unteren Rand der PDF-Dokumentseite angezeigt werden soll
-
setMarginRight(int value) - Der Rand in Millimetern, der rechts vom PDF-Dokument angezeigt werden soll
-
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: 1366
- 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
-
setClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
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
-
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
-
setWaitForElement(String value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
setCustomWaterMarkId(String value) - Fügen Sie eine benutzerdefinierte watermark zu jeder Seite des PDF-Dokuments
-
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.
- 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
-
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.
-
setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
-
setMergeId(String mergeId) - die ID eines Captures, das sein soll am Anfang des neuen PDF-Dokuments zusammengeführt
-
setPassword(String password) - der Passwort zum Schutz des PDF-Dokuments mit
Ö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
- 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
- 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
- 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.
-
setIncludeBackground(boolean value) - Wenn dies zutrifft, sollten die Hintergrundbilder der Webseite in die DOCX aufgenommen werden
-
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
-
setIncludeImages(boolean value) - Wenn dies zutrifft, sollten die Bilder der Webseite in die DOCX aufgenommen werden
-
setTitle(String value) - Geben Sie dem DOCX-Dokument einen Titel
-
setMarginTop(int value) - Der Rand in Millimetern, der oben auf der DOCX-Dokumentseite angezeigt werden soll
-
setMarginLeft(int value) - Der Rand in Millimetern, der links auf der DOCX-Dokumentseite angezeigt werden soll
-
setMarginBottom(int value) - Der Rand in Millimetern, der am unteren Rand der DOCX-Dokumentseite angezeigt werden soll
-
setMarginRight(int value) - der Rand in Millimetern, der rechts vom DOCX-Dokument angezeigt werden soll
-
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: 1366
- 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
-
setClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
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
-
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
-
setWaitForElement(String value) - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
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.
- 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
-
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.
-
setNoAds(boolean noAds) - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
setNoCookieNotifications(boolean noCookieNotifications) - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
-
setMergeId(String mergeId) - die ID eines Captures, das sein soll am Anfang des neuen DOCX-Dokuments zusammengeführt
-
setPassword(String mergeId) - der Passwort zum Schutz des DOCX-Dokuments mit
Ö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
- 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.
- 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.
- 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
-
setTableNumberToInclude(int value) - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
-
setFormat(TableFormat value) - das Format, in dem die Tabelle sein soll
-
setIncludeHeaderNames(boolean value) - ob echte Headernamen in die Tabelle aufgenommen werden
-
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
-
setTargetElement(String value) - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
-
setRequestAs(BrowserType value) - die Art des Benutzeragenten, den Sie verwenden möchten
-
setCountry(Country value) - das Land Der Screenshot sollte von genommen werden.
- 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
-
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.
-
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.
-
setProxy(String proxy) - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Ö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
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
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 saveToDatei)
Save das Ergebnis synchron zu einer Datei.
Parameter
-
saveToDatei - Der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
Rückgabewert
Gibt true zurück, wenn es erfolgreich ist, andernfalls wird eine Ausnahme ausgelöst.
Status Status bekommen(String Ich würde)
Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.
Parameter
-
id - Die eindeutige Kennung des Screenshots
Rückgabewert
Status Objekt
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
Rückgabewert
GrabzItCookie Array
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
-
domain - Die Domain der Website, für die das Cookie festgelegt werden soll
- 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
-
domain - Die Domain der Website, für die das Cookie gelöscht werden soll
Rückgabewert
True, wenn der Cookie erfolgreich gelöscht wurde, andernfalls false
WaterMark[] Erhalten Sie WaterMarks()
Holen Sie sich alle Ihre hochgeladenen benutzerdefinierten watermarks
Rückgabewert
WaterMark Array
WaterMark Erhalten Sie WaterMark(String Kennung)
Geben Sie Ihre Gewohnheit zurück watermarks das entspricht der angegebenen Kennung
Parameter
-
bezeichner - der bezeichner eines bestimmten benutzerdefinierten watermark Sie möchten anzeigen
Rückgabewert
WaterMark Objekt
Fügen Sie einen neuen Benutzer hinzu watermark
Parameter
-
Bezeichner - Der Bezeichner, den Sie dem Benutzer geben möchten watermark. Es ist wichtig, dass diese Kennung eindeutig ist.
-
Pfad - der absolute Pfad des watermark auf Ihrem Server. Zum Beispiel C: /watermark/1.png
-
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 die watermark wurde erfolgreich eingestellt
DeleteWaterMark(String Kennung)
Löschen Sie eine benutzerdefinierte watermark
Parameter
-
bezeichner - der bezeichner des benutzerdefinierten watermark Sie möchten löschen
Rückgabewert
gibt true zurück, wenn die watermark wurde erfolgreich gelöscht
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
UseSSL (boolean Wert)
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
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
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
- AGB
- LETTER
PageOrientation
Diese Aufzählung umfasst die folgenden Werte.
CSSMediaType
Diese Aufzählung umfasst die folgenden Werte.
TableFormat
Diese Aufzählung umfasst die folgenden Werte.
HorizontalPosition
Diese Aufzählung umfasst die folgenden Werte.
- LINKS
- STADTZENTRUM
- RECHTS
VerticalPosition
Diese Aufzählung umfasst die folgenden Werte.
Ergebnisklassen
Cookie
Öffentliche Eigenschaften
-
String getName()
-
String getValue()
-
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()
Status
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 ist abgelaufen()
- 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 den Brauch watermarks in GrabzIt gespeichert
Öffentliche Methoden