Description

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

Méthodes publiques

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

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

GrabzItFile objet

---

URLToAnimation(String url, AnimationOptions options)

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

Paramètres

• url - l'URL de la vidéo en ligne à convertir into un GIF animé.
  • Requis
  • Accepte les URL de vidéos Vimeo et YouTube
    • Avertissement L'animation de vidéos Vimeo et YouTube dépend d'un tiers et peut donc ne pas fournir des résultats cohérents.
• Options - une instance de AnimationOptions classe qui définit les options spéciales à utiliser lors de la création du fichier GIF animé.

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

• setCustomId(String value) - identificateur personnalisé que vous pouvez transmettre au service Web GIF animé. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setWidth(int value) - la largeur du GIF animé obtenu en pixels.
  • Par défaut: 180px
  • Maximum: Largeur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la largeur de la le GIF animé est mis à l'échelle par rapport à sa hauteur, si la largeur est auto-dimensionnée, la hauteur ne peut pas)
• setHeight(int value) - la hauteur du GIF animé obtenu en pixels.
  • Par défaut: 120px
  • Maximum: hauteur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la hauteur de la le GIF animé est mis à l'échelle par rapport à sa largeur, si la hauteur est automatiquement dimensionnée, la largeur ne peut pas)
• setStart(int value) - la position de départ de la vidéo à convertir into un GIF animé.
  • Par défaut: secondes 0
• setDuration(int value) - la durée en secondes de la vidéo à convertir into un GIF animé.
  • Valeur par défaut: longueur maximale du paquet
• setSpeed(float value) - la vitesse du GIF animé.
  • Par défaut: 1
  • Minimum: 0.2
  • Maximum: 10
• setFramesPerSecond(float value) - le nombre d'images par seconde devant être capturées à partir de la vidéo.
  • Par défaut: 10
  • Minimum: 0.2
  • Maximum: 60
• setRepeat(int value) - nombre de fois pour boucler le GIF animé.
  • Par défaut: 0
  • Boucle en continu: 0
  • Ne jamais boucler : -1
• setReverse(boolean value) - si vrai, les images du GIF animé sont inversées
  • Par défaut: false
• setCustomWaterMarkId(String value) - ajouter personnalisé watermark au GIF animé
  • Par défaut: vide
• setQuality(int value) - la qualité de l'image retournée, qui a une compression par défaut de 85%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry(Country value) - le pays le GIF animé doit provenir de.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.SINGAPOUR, Pays.ROYAUME-UNI, Pays.ÉTATS UNIS
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

---

URLToImage(String url, ImageOptions options)

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

Paramètres

• url - l'URL de la capture d'écran
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création de la capture d'écran.

Valeur de retour

annuler

HTMLToImage(String html, ImageOptions options)

Spécifie le HTML à convertir into une image.

Paramètres

• html - le HTML à convertir into une image
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.

Valeur de retour

annuler

FileToImage(String chemin, ImageOptions options)

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

Paramètres

• chemin - le chemin du fichier HTML à convertir into une image
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.

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

• setCustomId(String value) - identifiant personnalisé que vous pouvez transmettre au service Web de capture d'écran. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setBrowserWidth(int value) - la largeur du navigateur en pixels
  • Par défaut: 1366
  • Maximum: 10000
• setBrowserHeight(int value) - la hauteur du navigateur en pixels
  • Par défaut: 1170
  • Maximum: 10000
  • Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
• setOutputWidth(int value) - la largeur de la vignette obtenue en pixels
  • Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la hauteur de sortie est spécifiée, la largeur de sortie sera proportionnelle à la hauteur de sortie
  • Maximum: Largeur maximale pour le colis
  • Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
• setOutputHeight(int value) - la hauteur de la vignette obtenue en pixels
  • Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la largeur de sortie est spécifiée, la hauteur de sortie sera proportionnelle à la largeur de sortie
  • Maximum: hauteur maximale pour le colis
  • Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
• setFormat(ImageFormat value) - le format de la capture d'écran doit être.
  • Valeur par défaut: ImageFormat. JPG
  • options: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormat.BMP, ImageFormat.TIFF, ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setClickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
• setTargetElement(String value) - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une capture d’écran, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement(String value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement(String value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setRequestAs(BrowserType value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.STANDARDBROWSER
  • options: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTEUR DE RECHERCHE
• setCustomWaterMarkId(String value) - ajouter une personnalisation watermark à l'image
  • Par défaut: vide
• setQuality(int value) - la qualité de l'image retournée. Actuellement, cela affecte uniquement les images JPG et WEBP, qui ont une compression par défaut de 90%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setTransparent(boolean value) - si c'est vrai le la capture d'image doit être transparente. Ceci est uniquement compatible avec les images png et tiff.
  • Par défaut: false
• setHd(boolean value) - si vrai l'image capture sera en haute définition cela double la taille des dimensions de l'image.
  • Par défaut: false
• setCountry(Country value) - le pays la capture d'écran doit être prise à partir de.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.SINGAPOUR, Pays.ROYAUME-UNI, Pays.ÉTATS UNIS
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds(boolean noAds) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications(boolean noCookieNotifications) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress(String address) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (String prénom, String valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

---

URLToRenderedHTML(String url, HTMLOptions options)

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

Paramètres

• url - l'URL dont le HTML rendu devrait être composé
  • Requis
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création du code HTML rendu.

Valeur de retour

annuler

HTMLToRenderedHTML(string html, HTMLOptions options)

Spécifie le HTML à convertir into rendu HTML.

Paramètres

• html - le HTML à convertir into rendu HTML
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.

Valeur de retour

annuler

FileToRenderedHTML(string chemin, HTMLOptions options)

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

Paramètres

• chemin - le chemin du fichier HTML à convertir into rendu HTML
  • Requis
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.

Valeur de retour

annuler

HTMLOptions

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

Propriétés publiques

• setCustomId(String value) - identifiant personnalisé que vous pouvez transmettre au service Web. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setBrowserWidth(int value) - la largeur du navigateur en pixels
  • Par défaut: 1366
  • Maximum: 10000
• setBrowserHeight(int value) - la hauteur du navigateur en pixels
  • Par défaut: 1170
  • Maximum: 10000
• setWaitForElement(String value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setRequestAs(BrowserType value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.STANDARDBROWSER
  • options: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTEUR DE RECHERCHE
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds(boolean noAds) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications(boolean noCookieNotifications) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress(String address) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (String prénom, String valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

---

URLToPDF(String url, PDFOptions options)

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

Paramètres

• url - l'URL à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe PDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

HTMLToPDF(String html, PDFOptions options)

Spécifie le HTML à convertir into un PDF.

Paramètres

• html - le HTML à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe PDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

Valeur de retour

annuler

FileToPDF(String chemin, PDFOptions options)

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

Paramètres

• chemin - le chemin du fichier HTML à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe PDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.

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

• setCustomId(String value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setIncludeBackground(boolean value) - si vrai, l'arrière-plan de la page Web devrait être inclus dans la capture d'écran
  • Par défaut: true
• setPageSize(PageSize value) - la taille de la page du PDF
  • Valeur par défaut: PageSize.A4
  • options: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LÉGAL, PageSize.LETTRE
• setOrientation(PageOrientation value) - l'orientation du document PDF
  • Valeur par défaut: PageOrientation.PORTRAIT
  • options: PageOrientation.PORTRAIT, PageOrientation.PAYSAGE
• setCSSMediaType(CSSMediaType value) - la Type de média CSS du document PDF
  • Valeur par défaut: CSSMediaType.ÉCRAN
  • options: CSSMediaType.ÉCRAN, CSSMediaType.PRINT
• setIncludeLinks(boolean value) - vrai si les liens doivent être inclus dans le PDF
  • Par défaut: true
• setIncludeOutline(boolean value) - vrai si Signets PDF devrait être inclus
  • Par défaut: false
• setTitle(String value) - donner un titre au document PDF
  • Par défaut: vide
• setCoverURL(string value) - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
  • Par défaut: vide
• setMarginTop(int value) - la marge en millimètres devant apparaître en haut de la page du document PDF
  • Par défaut: 10
• setMarginLeft(int value) - la marge en millimètres devant apparaître à gauche de la page du document PDF
  • Par défaut: 10
• setMarginBottom(int value) - la marge en millimètres qui devrait apparaître au bas de la page du document PDF
  • Par défaut: 10
• setMarginRight(int value) - la marge en millimètres devant apparaître à droite du document PDF
  • Par défaut: 10
• setBrowserWidth(int value) - le le largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1366
  • Maximum: 10000
  • Largeur automatique: -1 (passant -1 signifie que la largeur du navigateur correspond à la largeur du document PDF)
• setPageWidth(int value) - la largeur personnalisée du PDF résultant en mm
  • Valeur par défaut: PageSize largeur
  • Minimum: 15
• setPageHeight(int value) - la hauteur personnalisée du PDF résultant en mm
  • Valeur par défaut: PageSize la taille
  • Minimum: 15
• setDelay(int value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setRequestAs(BrowserType value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.STANDARDBROWSER
  • options: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTEUR DE RECHERCHE
• setTemplateId(String value) - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document PDF
  • Par défaut: vide
• setClickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
• setTargetElement(String value) - la Sélecteur CSS du seul Élément HTML sur la page Web cible à tourner into un PDF, toutes les autres parties de la page Web sont ignorées. S'il y a plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement(String value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement(String value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setCustomWaterMarkId(String value) - ajouter une personnalisation watermark à chaque page du document PDF
  • Par défaut: vide
• setQuality(int value) - la qualité du PDF retourné. La valeur par défaut utilise la qualité recommandée pour le PDF.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry(Country value) - le pays la capture d'écran doit être prise à partir de.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.SINGAPOUR, Pays.ROYAUME-UNI, Pays.ÉTATS UNIS
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds(boolean noAds) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications(boolean noCookieNotifications) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress(String address) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• setMergeId(String mergeId) - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document PDF
  • Par défaut: vide
• setPassword(String password) - la mot de passe pour protéger le document PDF avec
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (String prénom, String valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter (String prénom, String valeur) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

---

URLToDOCX (String url, DOCXOptions options)

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

Paramètres

• url - l'URL à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de DOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

HTMLToDOCX(String html, DOCXOptions options)

Spécifie le HTML à convertir into un DOCX.

Paramètres

• html - le HTML à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de DOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

Valeur de retour

annuler

FileToDOCX(String chemin, DOCXOptions options)

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

Paramètres

• chemin - le chemin du fichier HTML à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de DOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.

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

• setCustomId(String value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• setIncludeBackground(boolean value) - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• setPageSize(PageSize value) - la taille de la page du DOCX
  • Valeur par défaut: PageSize.A4
  • options: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LÉGAL, PageSize.LETTRE
• setOrientation(PageOrientation value) - l'orientation du document DOCX
  • Valeur par défaut: PageOrientation.PORTRAIT
  • options: PageOrientation.PORTRAIT, PageOrientation.PAYSAGE
• setIncludeLinks(boolean value) - vrai si les liens doivent être inclus dans le DOCX
  • Par défaut: true
• setIncludeImages(boolean value) - si vrai, les images de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• setTitle(String value) - donner un titre au document DOCX
  • Par défaut: vide
• setMarginTop(int value) - la marge en millimètres devant apparaître en haut de la page du document DOCX
  • Par défaut: 10
• setMarginLeft(int value) - la marge en millimètres devant apparaître à gauche de la page du document DOCX
  • Par défaut: 10
• setMarginBottom(int value) - la marge en millimètres devant apparaître au bas de la page du document DOCX
  • Par défaut: 10
• setMarginRight(int value) - la marge en millimètres devant figurer à droite du document DOCX
  • Par défaut: 10
• setBrowserWidth(int value) - la largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1366
  • Maximum: 10000
  • Largeur automatique: -1 (passant -1 signifie que la largeur du navigateur correspond à la largeur du document PDF)
• setPageWidth(int value) - la largeur personnalisée du DOCX résultant en mm
  • Valeur par défaut: PageSize largeur
  • Minimum: 15
• setPageHeight(int value) - la hauteur personnalisée du DOCX résultant en mm
  • Valeur par défaut: PageSize la taille
  • Minimum: 15
• setDelay(int value) - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• setRequestAs(BrowserType value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.STANDARDBROWSER
  • options: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTEUR DE RECHERCHE
• setTemplateId(String value) - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document DOCX
  • Par défaut: vide
• setClickElement - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
• setTargetElement(String value) - la Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une capture d’écran, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• setHideElement(String value) - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• setWaitForElement(String value) - la Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• setQuality(int value) - la qualité du DOCX retourné. La valeur par défaut utilise la qualité recommandée pour le fichier DOCX.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• setCountry(Country value) - le pays la capture d'écran doit être prise à partir de.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.SINGAPOUR, Pays.ROYAUME-UNI, Pays.ÉTATS UNIS
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setNoAds(boolean noAds) - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• setNoCookieNotifications(boolean noCookieNotifications) - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• setAddress(String address) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• setMergeId(String mergeId) - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document DOCX
  • Par défaut: vide
• setPassword(String mergeId) - la mot de passe pour protéger le document DOCX avec
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (String prénom, String valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter (String prénom, String valeur) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

---

URLToTable(String url, TableOptions options)

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

Paramètres

• url - l'URL à partir de laquelle extraire les tables HTML
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

HTMLToTable (String html, TableOptions options)

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

Paramètres

• html - HTML pour extraire les tables HTML.
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

Valeur de retour

annuler

FileToTable (String chemin, TableOptions options)

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

Paramètres

• chemin - le chemin du fichier HTML à partir duquel extraire les tableaux HTML.
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.

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

• setCustomId(String value) - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée
  • Par défaut: vide
• setTableNumberToInclude(int value) - l'index de la table à convertir, si toutes les tables d'une page Web sont ordonnées du haut de la page Web vers le bas
  • Par défaut: 1
• setFormat(TableFormat value) - le format dans lequel le tableau doit être
  • Valeur par défaut: TableFormat.CSV
  • options: TableFormat.CSV, TableFormat.JSON, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - si de vrais noms d'en-tête seront inclus dans la table
  • Par défaut: true
• setIncludeAllTables(boolean value) - Si vrai, tous les tableaux de la page Web seront extraits, chaque tableau apparaissant dans une feuille de calcul distincte. Disponible uniquement avec le format XLSX
  • Par défaut: false
• setTargetElement(String value) - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
  • Par défaut: vide
• setRequestAs(BrowserType value) - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.STANDARDBROWSER
  • options: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTEUR DE RECHERCHE
• setCountry(Country value) - le pays la capture d'écran doit être prise à partir de.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.SINGAPOUR, Pays.ROYAUME-UNI, Pays.ÉTATS UNIS
• setExportURL(String value) - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• setEncryptionKey(String key) - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• setAddress(String address) - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• setProxy(String proxy) - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (String prénom, String valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

---

Save()

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 GetResult méthode.

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 le GetResult méthode

---

Save(String URL de rappel)

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 GetResult méthode.

Paramètres

• callBackURL - le maître le service GrabzIt doit appeler après avoir terminé son travail
  • Requis

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 le GetResult méthode

GrabzItFile SaveTo()

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

Valeur de retour

GrabzItFile objet

---

SaveTo(String saveToFichier)

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

Paramètres

• saveToFichier - le chemin du fichier qui sera capturé saved à une fois qu'il a été complété
  • Requis

Valeur de retour

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

---

Statut GetStatus (String id)

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

Paramètres

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

Statut objet

---

GrabzItCookie [] GetCookies (String 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

• domain - le domaine pour lequel les cookies sont renvoyés
  • Requis

Valeur de retour

GrabzItCookie tableau

---

SetCookie (String prénom, String domaine, String valeur, String chemin, boolean httponly, la date expire)

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

• name - le nom du cookie à définir
  • Requis
• domain - le domaine du site Web pour définir le cookie pour
  • Requis
• valeur - la valeur du cookie
• chemin - le chemin du site auquel le cookie se rapporte
• httponly - si vrai, le cookie ne peut être utilisé qu'avec le protocole HTTP
• expires - définit quand le cookie expire. Passer une valeur nulle si le cookie ne doit pas expirer

Valeur de retour

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

---

DeleteCookie (String prénom, String domaine)

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

Paramètres

• name - le nom du cookie à supprimer
  • Requis
• domain - le domaine du site Web pour supprimer le cookie pour
  • Requis

Valeur de retour

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

---

WaterMark[] ObtenezWaterMarks()

Obtenez toute votre personnalisation téléchargée watermarks

Valeur de retour

WaterMark tableau

---

WaterMark ObtenezWaterMark(String identifiant)

Renvoyez votre coutume watermarks qui correspond à l'identifiant spécifié

Paramètres

• identifier - l'identifiant d'une coutume particulière watermark tu veux voir
  • Requis

Valeur de retour

WaterMark objet

---

AjouterWaterMark(String identifiant, String chemin, HorizontalPosition xpos, VerticalPosition ypos)

Ajouter une nouvelle personnalisation watermark

Paramètres

• identifiant - l'identifiant que vous souhaitez donner à la personnalisation watermark. Il est important que cet identifiant soit unique.
  • Requis
• chemin - le chemin absolu du watermark sur votre serveur. Par exemple C: /watermark/1.png
  • Requis
• xpos - la position horizontale dans laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options: HorizontalPosition.LA GAUCHE, HorizontalPosition.CENTRE, HorizontalPosition.DROITE
• ypos - position verticale sur laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options: VerticalPosition.HAUT, VerticalPosition.MILIEU, VerticalPosition.BAS

Valeur de retour

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

---

DeleteWaterMark(String identifiant)

Supprimer une personnalisation watermark

Paramètres

• identifier - l'identifiant de la coutume watermark tu veux supprimer
  • Requis

Valeur de retour

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

---

SetLocalProxy (String proxyUrl)

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

Paramètres

• proxyUrl - l'URL, qui peut inclure un port si nécessaire, du proxy. Fournir une valeur nulle supprimera tout proxy précédemment défini
  • Requis

---

UseSSL (boolean valeur)

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

Paramètres

• valeur - si vrai, toutes les demandes adressées à l'API de GrabzIt utiliseront SSL
  • Requis

---

String CreateEncryptionKey ()

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

---

Décrypter (String chemin, String clé)

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

Paramètres

• chemin - le chemin de la capture cryptée
  • Requis
• clé - la clé de chiffrement
  • Requis

---

GrabzItFile Décrypter (GrabzItFile fichier, String clé)

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

Paramètres

• fichier - le crypté GrabzItFile
  • Requis
• clé - la clé de chiffrement
  • Requis

---

byte [] Decrypt (byte [] data, String clé)

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

Paramètres

• data - les octets cryptés
  • Requis
• clé - la clé de chiffrement
  • Requis

---

Enums

ImageFormat

Cette énumération comprend les valeurs suivantes.

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

---

BrowserType

Cette énumération comprend les valeurs suivantes.

• STANDARDBROWSER
• MOBILEBROWSER
• MOTEUR DE RECHERCHE

---

Pays

Cette énumération comprend les valeurs suivantes.

• DEFAULT
• SINGAPOUR
• ROYAUME-UNI
• ÉTATS UNIS

---

PageSize

Cette énumération comprend les valeurs suivantes.

• A3
• A4
• A5
• A6
• B3
• B4
• B5
• B6
• LÉGAL
• LETTRE

---

PageOrientation

Cette énumération comprend les valeurs suivantes.

• PAYSAGE
• PORTRAIT

---

CSSMediaType

Cette énumération comprend les valeurs suivantes.

• IMPRIMER
• ÉCRAN

---

TableFormat

Cette énumération comprend les valeurs suivantes.

• CSV
• JSON
• XSLX

---

HorizontalPosition

Cette énumération comprend les valeurs suivantes.

• en stock
• CENTRE
• DROIT

---

VerticalPosition

Cette énumération comprend les valeurs suivantes.

• TOP
• MOYEN
• BAS

---

Classes de résultat

Biscuits

Propriétés publiques

• String getName()
  • Le nom du cookie.
• String getValue()
  • La valeur du cookie.
• String getDomain()
  • Le domaine pour lequel le cookie est défini.
• String getPath()
  • Le chemin d'accès au domaine auquel ce cookie s'applique.
• String getHttpOnly()
  • Si ce cookie n'est valide que lorsque le site Web est visualisé avec le protocole HTTP.
• String getExpires()
  • La date d'expiration de ce cookie
• String getType()
  • Il s'agit du type de cookie, qui peut être l'un des suivants:
    • Global - il s'agit d'un cookie global défini par GrabzIt
    • Local - il s'agit d'un cookie local défini par vous
    • Overridden - un cookie global que vous avez remplacé

GrabzItFile

Méthodes publiques

• byte [] getBytes ()
• annuler Save(String Chemin)
• String àString()

Statut

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

Méthodes publiques

• boolean isProcessing ()
  • Si vrai, la capture d'écran est toujours en cours de traitement.
• boolean isCached ()
  • Si la valeur est true, la capture d'écran a été traitée et est actuellement mise en cache.
• boolean est expiré()
  • Si vrai, la capture d'écran n'est plus sur le système GrabzIt.
• String getMessage ()
  • Un message d'erreur renvoyé par le système.

WaterMark

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

Méthodes publiques

• String getIdentifier ()
• String getFormat ()
• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()