Tools zum Erfassen und Konvertieren des Webs

GrabzIt Client mit Ruby

Ruby API

Produktbeschreibung

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

Öffentliche Methoden

get_result (id)

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

Rückgabewert

Die Gefangennahme


url_to_animation(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

AnimationOptions

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

Öffentliche Eigenschaften


url_to_image(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

html_to_image(html, Optionen = null)

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

Parameter

Rückgabewert

ungültig

file_to_image(Pfad, Optionen = null)

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

Parameter

Rückgabewert

ungültig

ImageOptions

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

Öffentliche Eigenschaften

Öffentliche Methoden


url_to_rendered_html(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

html_to_rendered_html(html, Optionen = null)

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

Parameter

Rückgabewert

ungültig

file_to_rendered_html(Pfad, Optionen = null)

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

Parameter

Rückgabewert

ungültig

HTMLOptions

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

Öffentliche Eigenschaften

Öffentliche Methoden


url_to_pdf(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

html_to_pdf(html, Optionen = null)

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

Parameter

Rückgabewert

ungültig

file_to_pdf(Pfad, Optionen = null)

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

Parameter

Rückgabewert

ungültig

PDFOptions

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

Öffentliche Eigenschaften

Öffentliche Methoden


url_to_docx(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

html_to_docx(html, Optionen = null)

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

Parameter

Rückgabewert

ungültig

file_to_docx(Pfad, Optionen = null)

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

Parameter

Rückgabewert

ungültig

DOCXOptions

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

Öffentliche Eigenschaften

Öffentliche Methoden


url_to_table(URL, Optionen = null)

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

Parameter

Rückgabewert

ungültig

html_to_table(html, Optionen = null)

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

Parameter

Rückgabewert

ungültig

file_to_table(Pfad, Optionen = null)

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

Parameter

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

Öffentliche Methoden


Dies ist die empfohlene Methode zum Speichern einer Datei

save(callBackURL = nil)

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

Parameter

Rückgabewert

Andernfalls wird die eindeutige Kennung des Screenshots ausgelöst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit der Methode get_result abzurufen


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

save_to()

Save das Ergebnis synchron zu einer Variablen, die die Screenshot-Bytedaten enthält.

Rückgabewert

Gibt bei Erfolg die Bytedaten der Datei zurück, andernfalls wird eine Ausnahme ausgelöst.


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

save_to(saveToDatei)

Save das Ergebnis synchron zu einer Datei.

Parameter

Rückgabewert

Gibt true zurück, wenn es erfolgreich ist, andernfalls wird eine Ausnahme ausgelöst.


get_status(Ich würde)

Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.

Parameter

Rückgabewert

ScreenShotStatus Objekt


get_cookies(Domain)

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

Parameter

Rückgabewert

Cookie Feld


set_cookie (name, domain, value = "", path = "/", httponly = false, expires = "")

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

Rückgabewert

True, wenn das Cookie erfolgreich gesetzt wurde, andernfalls false


delete_cookie (name, domain)

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

Parameter

Rückgabewert

True, wenn der Cookie erfolgreich gelöscht wurde, andernfalls false


bekommen_watermarks()

Holen Sie sich Ihre hochgeladene benutzerdefinierte watermarks

Rückgabewert

WaterMark Feld


bekommen_watermark(Kennung)

Holen Sie sich Ihre hochgeladene benutzerdefinierte watermarks

Parameter

Rückgabewert

WaterMark


hinzufügen_watermark(Bezeichner, Pfad, xpos, ypos)

Fügen Sie einen neuen Benutzer hinzu watermark

Parameter

Rückgabewert

gibt true zurück, wenn die watermark wurde erfolgreich eingestellt


löschen_watermark(Kennung)

Löschen Sie eine benutzerdefinierte watermark

Parameter

Rückgabewert

gibt true zurück, wenn die watermark wurde erfolgreich gelöscht


set_local_proxy (Wert)

Diese Methode ermöglicht a lokaler Proxy-Server für alle Anfragen zu verwenden.

Parameter


use_ssl (Wert)

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

Parameter


create_encryption_key ()

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


entschlüsseln (Daten, Schlüssel)

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

Parameter


Entschlüsselungsdatei (Pfad, Schlüssel)

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

Parameter


Ergebnisklassen

Cookie

Öffentliche Eigenschaften

ScreenShotStatus

Die Klasse, die den aktuellen Status des Screenshots darstellt.

Öffentliche Eigenschaften

WaterMark

Diese Klasse repräsentiert den Brauch watermarks in GrabzIt gespeichert

Öffentliche Eigenschaften