Outils pour capturer et convertir le Web

Client GrabzIt avec Ruby

API Ruby

Détails

Cette classe gère toutes les communications avec les services Web de capture d’écran GrabzIt.

Méthodes publiques

get_result (id)

Cette méthode renvoie la capture d'écran elle-même. Si rien n'est renvoyé, alors quelque chose s'est mal passé ou la capture d'écran n'est pas encore prête.

Paramètres

Valeur de retour

La capture


url_to_animation(url, Options = nul)

Spécifiez l'URL de la vidéo en ligne à convertir into un GIF animé.

Paramètres

Valeur de retour

annuler

AnimationOptions

La classe représente toutes les options disponibles lors de la création d'un fichier GIF animé.

Propriétés publiques


url_to_image(url, Options = nul)

Spécifie l'URL à convertir into une image capture d'écran.

Paramètres

Valeur de retour

annuler

html_to_image(html, Options = nul)

Spécifie le HTML à convertir into une image.

Paramètres

Valeur de retour

annuler

file_to_image(chemin, Options = nul)

Spécifie un fichier HTML à convertir into une image.

Paramètres

Valeur de retour

annuler

ImageOptions

La classe représente toutes les options disponibles lors de la création de captures d'image.

Propriétés publiques

Méthodes publiques


url_to_rendered_html(url, Options = nul)

Spécifie l'URL à convertir into rendu HTML.

Paramètres

Valeur de retour

annuler

html_to_rendered_html(html, Options = nul)

Spécifie le HTML à convertir into rendu HTML.

Paramètres

Valeur de retour

annuler

file_to_rendered_html(chemin, Options = nul)

Spécifie un fichier HTML à convertir into rendu HTML.

Paramètres

Valeur de retour

annuler

HTMLOptions

La classe représente toutes les options disponibles lorsque création de captures HTML rendues.

Propriétés publiques

Méthodes publiques


url_to_pdf(url, Options = nul)

Spécifie l'URL à convertir into un PDF.

Paramètres

Valeur de retour

annuler

html_to_pdf(html, Options = nul)

Spécifie le HTML à convertir into un PDF.

Paramètres

Valeur de retour

annuler

file_to_pdf(chemin, Options = nul)

Spécifie un fichier HTML à convertir into un PDF.

Paramètres

Valeur de retour

annuler

PDFOptions

La classe représente toutes les options disponibles lors de la création de captures PDF.

Propriétés publiques

Méthodes publiques


url_to_docx(url, Options = nul)

Spécifie l'URL à convertir into un DOCX.

Paramètres

Valeur de retour

annuler

html_to_docx(html, Options = nul)

Spécifie le HTML à convertir into un DOCX.

Paramètres

Valeur de retour

annuler

file_to_docx(chemin, Options = nul)

Spécifie un fichier HTML à convertir into un DOCX.

Paramètres

Valeur de retour

annuler

DOCXOptions

La classe représente toutes les options disponibles lors de la création de captures DOCX.

Propriétés publiques

Méthodes publiques


url_to_table(url, Options = nul)

Spécifie l'URL à partir de laquelle les tables HTML doivent être extraites.

Paramètres

Valeur de retour

annuler

html_to_table(html, Options = nul)

Spécifie le HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

Valeur de retour

annuler

file_to_table(chemin, Options = nul)

Spécifie un fichier HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

Valeur de retour

annuler

TableOptions

La classe représente toutes les options disponibles lors de la conversion de tableaux HTML en fichiers CSV, XLSX ou JSON.

Propriétés publiques

Méthodes publiques


C'est la méthode recommandée pour sauvegarder un fichier

save(callBackURL = nil)

Save le résultat de manière asynchrone et renvoie un identifiant unique, qui peut être utilisé pour obtenir la capture d'écran avec le get_result méthode.

Paramètres

Valeur de retour

L'identifiant unique de la capture d'écran sinon, si une erreur survient, une exception est levée. Ceci peut être utilisé pour obtenir la capture d'écran avec la méthode get_result


Attention, cette méthode est synchrone et va donc mettre une application en pause pendant le traitement du résultat

save_to()

Save le résultat de manière synchrone à une variable contenant les données d'octet de capture d'écran.

Valeur de retour

renvoie les données d'octet du fichier en cas de succès, sinon une exception est levée.


Attention, cette méthode est synchrone et va donc mettre une application en pause pendant le traitement du résultat

save_to(saveToFichier)

Save le résultat de manière synchrone à un fichier.

Paramètres

Valeur de retour

retourne le vrai s'il réussit, sinon il lève une exception.


get_status(id)

Obtenir le statut actuel d'une capture d'écran GrabzIt.

Paramètres

Valeur de retour

ScreenShotStatus objet


get_cookies(domaine)

Obtenez tous les cookies que GrabzIt utilise pour un domaine particulier. Cela peut également inclure les cookies définis par l'utilisateur.

Paramètres

Valeur de retour

Biscuits tableau


set_cookie (nom, domaine, valeur = "", chemin = "/", httponly = false, expires = "")

Définit un nouveau cookie personnalisé sur GrabzIt. Si le cookie personnalisé porte le même nom et le même domaine qu'un cookie global, le cookie global est remplacé.

Cela peut être utile si une fonctionnalité de site Web est contrôlée par des cookies.

Paramètres

Valeur de retour

Vrai si le cookie est installé avec succès, sinon faux


delete_cookie (nom, domaine)

Supprimer un cookie personnalisé ou bloquer l'utilisation d'un cookie global

Paramètres

Valeur de retour

Vrai si le cookie est supprimé avec succès, sinon faux


avoir_watermarks()

Obtenez votre personnalisé téléchargé watermarks

Valeur de retour

WaterMark tableau


avoir_watermark(identifiant)

Obtenez votre personnalisé téléchargé watermarks

Paramètres

Valeur de retour

WaterMark


ajouter_watermark(identifiant, chemin, xpos, ypos)

Ajouter une nouvelle personnalisation watermark

Paramètres

Valeur de retour

renvoie vrai si le watermark a été défini avec succès


effacer_watermark(identifiant)

Supprimer une personnalisation watermark

Paramètres

Valeur de retour

renvoie vrai si le watermark a été supprimé avec succès


set_local_proxy (valeur)

Cette méthode permet une serveur proxy local à utiliser pour toutes les demandes.

Paramètres


use_ssl (valeur)

Spécifie si les demandes à GrabzIt API devrait utiliser SSL

Paramètres


create_encryption_key ()

Créez une clé de chiffrement 64 de base sécurisée sur le plan cryptographique, longue de caractères 44.


déchiffrer (données, clé)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres


decrypt_file (chemin d'accès, clé)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres


Classes de résultat

Biscuits

Propriétés publiques

ScreenShotStatus

La classe représentant le statut actuel de la capture d'écran.

Propriétés publiques

WaterMark

Cette classe représente la coutume watermarks stocké dans GrabzIt

Propriétés publiques