GrabzItClient с Java

Описание

Этот класс обрабатывает все коммуникации с веб-сервисами GrabzIt.

Публичные методы

• 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 - уникальный идентификатор скриншота
  • необходимые

Возвращаемое значение

GrabzItFile объект

URLToAnimation(String URL, AnimationOptions опции)

Укажите URL-адрес онлайн-видео, которое необходимо преобразовать intанимированный GIF.

параметры

• url - URL видео онлайн для конвертации intо анимированный GIF.
  • необходимые
  • Принимает Vimeo и YouTube видео URL
    • Предупреждение о анимации видео Vimeo и YouTube зависит от третьей стороны и, следовательно, может не дать согласованных результатов
• опционы - экземпляр AnimationOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании анимированного GIF.

Возвращаемое значение

аннулировать

AnimationOptions

Класс представляет все параметры, доступные при создании анимированного GIF.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать через анимированный GIF веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setWidth(int value) - ширина получаемого анимированного GIF в пикселях.
  • По умолчанию: 180px
  • Максимум: максимальная ширина для упаковки
  • Авто-размер: -1 (передача -1 означает, что ширина анимированный GIF масштабируется по отношению к его высоте, если ширина автоматически измеряется, высота не может)
• setHeight(int value) - высота получаемого анимированного GIF в пикселях.
  • По умолчанию: 120px
  • Максимум: максимальная высота упаковки
  • Авто-размер: -1 (передача -1 означает, что высота анимированный GIF масштабируется по отношению к его ширине, если высота автоматически измеряется, ширина не может)
• setStart(int value) - начальная позиция видео, которое должно быть преобразовано intанимированный GIF.
  • По умолчанию: секунды 0
• setDuration(int value) - продолжительность видео в секундах, которое должно быть конвертировано intанимированный GIF.
  • По умолчанию: максимальная длина пакета
• setSpeed(float value) - скорость анимированного GIF.
  • По умолчанию: 1
  • Минимум: 0.2
  • Максимум: 10
• setFramesPerSecond(float value) - количество кадров в секунду, которое должно быть снято с видео.
  • По умолчанию: 10
  • Минимум: 0.2
  • Максимум: 60
• setRepeat(int value) - количество циклов анимированного GIF.
  • По умолчанию: 0
  • Цикл непрерывно: 0
• setReverse(boolean value) - если true, кадры анимированного GIF меняются местами
  • По умолчанию: false
• setCustomWaterMarkId(String value) - добавить кастом watermark в анимированный GIF
  • По умолчанию: пусто
• setQuality(int value) - качество возвращаемого изображения, который имеет сжатие по умолчанию 85%.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry(Country value) - страна анимированный GIF должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Опции: Страна.СИНГАПУР, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.СОЕДИНЕННЫЕ ШТАТЫ
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

URLToImage(String URL, ImageOptions опции)

Определяет URL, который должен быть преобразован intскриншот изображения.

параметры

• url - URL, из которого должен быть сделан снимок экрана
  • необходимые
• опционы - экземпляр ImageOptions класс, который определяет любые специальные опции, которые будут использоваться при создании скриншота.

Возвращаемое значение

аннулировать

HTMLToImage(String HTML, ImageOptions опции)

Определяет HTML, который должен быть преобразован intoa изображение.

параметры

• HTML - HTML для преобразования intизображение
  • необходимые
• опционы - экземпляр ImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.

Возвращаемое значение

аннулировать

FileToImage(String дорожка, ImageOptions опции)

Определяет файл HTML, который должен быть преобразован intoa изображение.

параметры

• путь - путь к файлу HTML-файла для преобразования intизображение
  • необходимые
• опционы - экземпляр ImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.

Возвращаемое значение

аннулировать

ImageOptions

Класс представляет все параметры, доступные при создании снимков изображения.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать на веб-сервис скриншотов. Он будет возвращен с указанным вами обратным URL-адресом.
  • По умолчанию: пусто
• setBrowserWidth(int value) - ширина браузера в пикселях
  • По умолчанию: 1366
  • Максимум: 10000
• setBrowserHeight(int value) - высота браузера в пикселях
  • По умолчанию: 768
  • Максимум: 10000
  • Полная длина: -1 (пропуск -1 означает, что взят снимок всей веб-страницы)
• setWidth(int value) - ширина получаемого эскиза в пикселях
  • По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если высота вывода указана, ширина вывода будет пропорциональна высоте вывода.
  • Максимум: максимальная ширина для упаковки
  • Полная ширина: -1 (пропуск -1 означает, что ширина эскиза не уменьшается)
• setHeight(int value) - высота получаемого миниатюры в пикселях
  • По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если ширина вывода указана, высота вывода будет пропорциональна ширине вывода
  • Максимум: максимальная высота упаковки
  • Полная высота: -1 (пропуск -1 означает, что высота эскиза не уменьшается)
• setFormat(ImageFormat value) - формат скриншота должен быть в.
  • По умолчанию: ImageFormat. JPG
  • Опции: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormat.BMP, ImageFormat.TIFF, ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement(String value) - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into Скриншот, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement(String value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement(String value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setRequestAs(BrowserType value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: BrowserType.STANDARDBROWSER
  • Опции: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.ПОИСКОВЫЙ ДВИЖОК
• setCustomWaterMarkId(String value) - добавить кастом watermark к изображению
  • По умолчанию: пусто
• setQuality(int value) - качество возвращаемого изображения. В настоящее время это влияет только на изображения JPG и WEBP, сжатие которых по умолчанию составляет 90%.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setTransparent(boolean value) - если правда захват изображения должен быть прозрачным, Это совместимо только с изображениями PNG и TIFF.
  • По умолчанию: false
• setHd(boolean value) - если верно изображение захват будет в высоком разрешении это удваивает размер изображения.
  • По умолчанию: false
• setCountry(Country value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Опции: Страна.СИНГАПУР, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.СОЕДИНЕННЫЕ ШТАТЫ
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds(boolean noAds) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications(boolean noCookieNotifications) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress(String address) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter (String название, String стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

URLToRenderedHTML(String URL, HTMLOptions опции)

Определяет URL, который должен быть преобразован intо рендеринга HTML.

параметры

• url - URL-адрес, из которого должен быть выполнен визуализированный HTML
  • необходимые
• опционы - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

HTMLToRenderedHTML(string HTML, HTMLOptions опции)

Определяет HTML, который должен быть преобразован intо рендеринга HTML.

параметры

• HTML - HTML для преобразования intо рендеринг HTML
• опционы - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

FileToRenderedHTML(string дорожка, HTMLOptions опции)

Определяет файл HTML, который должен быть преобразован intо рендеринга HTML.

параметры

• путь - путь к файлу HTML-файла для преобразования intо рендеринг HTML
  • необходимые
• опционы - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.

Возвращаемое значение

аннулировать

HTMLOptions

Класс представляет все параметры, доступные при создание визуализированных захватов HTML.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setBrowserWidth(int value) - ширина браузера в пикселях
  • По умолчанию: 1366
  • Максимум: 10000
• setBrowserHeight(int value) - высота браузера в пикселях
  • По умолчанию: 768
  • Максимум: 10000
• setWaitForElement(String value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setRequestAs(BrowserType value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: BrowserType.STANDARDBROWSER
  • Опции: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.ПОИСКОВЫЙ ДВИЖОК
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds(boolean noAds) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications(boolean noCookieNotifications) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress(String address) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter (String название, String стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

URLToPDF(String URL, PDFOptions опции)

Определяет URL, который должен быть преобразован intoa PDF.

параметры

• URL - URL, который должен быть преобразован intoa PDF
  • необходимые
• PDFOptions options - экземпляр класса PDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

HTMLToPDF(String HTML, PDFOptions опции)

Определяет HTML, который должен быть преобразован intoa PDF.

параметры

• HTML - HTML для преобразования intoa PDF
  • необходимые
• PDFOptions options - экземпляр класса PDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

FileToPDF(String дорожка, PDFOptions опции)

Определяет файл HTML, который должен быть преобразован intoa PDF.

параметры

• путь - путь к файлу HTML-файла для преобразования intoa PDF
  • необходимые
• PDFOptions options - экземпляр класса PDFOptions, который определяет любые специальные параметры, используемые при создании PDF.

Возвращаемое значение

аннулировать

PDFOptions

Класс представляет все параметры, доступные при создании снимков PDF.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setIncludeBackground(boolean value) - если true, фон веб-страницы должен быть включен в скриншот
  • По умолчанию: правда
• setPageSize(PageSize value) - размер страницы PDF
  • По умолчанию: PageSize.A4
  • Опции: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.ПИСЬМО
• setOrientation(PageOrientation value) - ориентация PDF документа
  • По умолчанию: PageOrientation.ПОРТРЕТ
  • Опции: PageOrientation.ПОРТРЕТ, PageOrientation.ПЕЙЗАЖ
• setCSSMediaType(CSSMediaType value) - CSS Media Тип документа PDF
  • По умолчанию: CSSMediaType.screen
  • Опции: CSSMediaType.screen, CSSMediaType.PRINT
• setIncludeLinks(boolean value) - true, если ссылки должны быть включены в PDF
  • По умолчанию: правда
• setIncludeOutline(boolean value) - правда, если PDF закладки должны быть включены
  • По умолчанию: false
• setTitle(String value) - укажите название документа PDF
  • По умолчанию: пусто
• setCoverURL(string value) - URL веб-страницы, которая должна использоваться в качестве обложки для PDF
  • По умолчанию: пусто
• setMarginTop(int value) - поле в миллиметрах, которое должно отображаться в верхней части страницы документа PDF
  • По умолчанию: 10
• setMarginLeft(int value) - поле в миллиметрах, которое должно появиться слева от страницы документа PDF
  • По умолчанию: 10
• setMarginBottom(int value) - поле в миллиметрах, которое должно отображаться внизу страницы документа PDF
  • По умолчанию: 10
• setMarginRight(int value) - поле в миллиметрах, которое должно отображаться справа от документа PDF
  • По умолчанию: 10
• setBrowserWidth(int value) - ширина браузера в пикселях
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
  • По умолчанию: 1366
  • Максимум: 10000
  • Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине PDF-документа)
• setPageWidth(int value) - пользовательская ширина полученного PDF в мм
  • По умолчанию: PageSize ширина
  • Минимум: 15
• setPageHeight(int value) - пользовательская высота получаемого PDF в мм
  • По умолчанию: PageSize высота
  • Минимум: 15
• setDelay(int value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setRequestAs(BrowserType value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: BrowserType.STANDARDBROWSER
  • Опции: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.ПОИСКОВЫЙ ДВИЖОК
• setTemplateId(String value) - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа PDF
  • По умолчанию: пусто
• setClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement(String value) - CSS селектор из единственного HTML-элемент на целевой веб-странице, которую нужно перевернуть intoa PDFвсе остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement(String value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement(String value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setCustomWaterMarkId(String value) - добавить кастом watermark на каждую страницу PDF-документа
  • По умолчанию: пусто
• setQuality(int value) - качество возвращаемого PDF, По умолчанию используется рекомендуемое качество для PDF.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry(Country value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Опции: Страна.СИНГАПУР, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.СОЕДИНЕННЫЕ ШТАТЫ
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds(boolean noAds) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications(boolean noCookieNotifications) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress(String address) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто
• setMergeId(String mergeId) - идентификатор захвата, который должен быть объединены в начале нового документа PDF
  • По умолчанию: пусто
• setPassword(String password) - пароль для защиты PDF документа с
  • По умолчанию: пусто

Публичные методы

• AddPostParameter (String название, String стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post
• AddTemplateParameter (String название, String стоимость) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
  • name - имя параметра шаблона
  • value - значение параметра шаблона

URLToDOCX (String URL, DOCXOptions опции)

Определяет URL, который должен быть преобразован intооо

параметры

• URL - URL, который должен быть преобразован intoa DOCX
  • необходимые
• DOCXOptions параметры - экземпляр DOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

HTMLToDOCX(String HTML, DOCXOptions опции)

Определяет HTML, который должен быть преобразован intооо

параметры

• HTML - HTML для преобразования intoa DOCX
  • необходимые
• DOCXOptions параметры - экземпляр DOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

FileToDOCX(String дорожка, DOCXOptions опции)

Определяет файл HTML, который должен быть преобразован intооо

параметры

• путь - путь к файлу HTML-файла для преобразования intoa DOCX
  • необходимые
• DOCXOptions параметры - экземпляр DOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.

Возвращаемое значение

аннулировать

DOCXOptions

Класс представляет все параметры, доступные при создании захватов DOCX.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
  • По умолчанию: пусто
• setIncludeBackground(boolean value) - если true, фоновые изображения веб-страницы должны быть включены в DOCX
  • По умолчанию: правда
• setPageSize(PageSize value) - размер страницы DOCX
  • По умолчанию: PageSize.A4
  • Опции: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.ПИСЬМО
• setOrientation(PageOrientation value) - ориентация документа DOCX
  • По умолчанию: PageOrientation.ПОРТРЕТ
  • Опции: PageOrientation.ПОРТРЕТ, PageOrientation.ПЕЙЗАЖ
• setIncludeLinks(boolean value) - true, если ссылки должны быть включены в DOCX
  • По умолчанию: правда
• setIncludeImages(boolean value) - если истина, изображения веб-страницы должны быть включены в DOCX
  • По умолчанию: правда
• setTitle(String value) - предоставить заголовок документа DOCX
  • По умолчанию: пусто
• setMarginTop(int value) - поле в миллиметрах, которое должно отображаться в верхней части страницы документа DOCX
  • По умолчанию: 10
• setMarginLeft(int value) - поле в миллиметрах, которое должно появиться слева от страницы документа DOCX
  • По умолчанию: 10
• setMarginBottom(int value) - поле в миллиметрах, которое должно отображаться внизу страницы документа DOCX
  • По умолчанию: 10
• setMarginRight(int value) - поле в миллиметрах, которое должно отображаться справа от документа DOCX
  • По умолчанию: 10
• setBrowserWidth(int value) - ширина браузера в пикселях
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
  • По умолчанию: 1366
  • Максимум: 10000
  • Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине PDF-документа)
• setPageWidth(int value) - пользовательская ширина результирующего DOCX в мм
  • По умолчанию: PageSize ширина
  • Минимум: 15
• setPageHeight(int value) - Пользовательская высота результирующего DOCX в мм
  • По умолчанию: PageSize высота
  • Минимум: 15
• setDelay(int value) - количество миллисекунд до подождите, прежде чем сделать скриншот
  • По умолчанию: 0
  • Максимум: 30000
• setRequestAs(BrowserType value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: BrowserType.STANDARDBROWSER
  • Опции: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.ПОИСКОВЫЙ ДВИЖОК
• setTemplateId(String value) - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа DOCX
  • По умолчанию: пусто
• setClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
  • Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
• setTargetElement(String value) - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into Скриншот, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
  • По умолчанию: пусто
• setHideElement(String value) - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
  • По умолчанию: пусто
• setWaitForElement(String value) - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
  • По умолчанию: пусто
• setQuality(int value) - качество возвращаемого DOCX, По умолчанию используется рекомендуемое качество для DOCX.
  • Снижение качества уменьшит размер файла и сократит время загрузки.
  • По умолчанию: -1
  • Минимум: -1
  • Максимум: 100
• setCountry(Country value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Опции: Страна.СИНГАПУР, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.СОЕДИНЕННЫЕ ШТАТЫ
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setNoAds(boolean noAds) - если правда реклама должна быть автоматически скрыта.
  • По умолчанию: false
• setNoCookieNotifications(boolean noCookieNotifications) - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
  • По умолчанию: false
• setAddress(String address) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто
• setMergeId(String mergeId) - идентификатор захвата, который должен быть объединены в начале нового документа DOCX
  • По умолчанию: пусто
• setPassword(String mergeId) - пароль для защиты документа DOCX с
  • По умолчанию: пусто

Публичные методы

• AddPostParameter (String название, String стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post
• AddTemplateParameter (String название, String стоимость) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
  • name - имя параметра шаблона
  • value - значение параметра шаблона

URLToTable(String URL, TableOptions опции)

Определяет URL, из которого должны быть извлечены таблицы HTML.

параметры

• url - URL для извлечения HTML-таблиц из
  • необходимые
• TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

HTMLToTable (String HTML, TableOptions опции)

Определяет HTML, из которого должны быть извлечены таблицы HTML.

параметры

• html - HTML-код для извлечения HTML-таблиц.
  • необходимые
• TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

FileToTable (String дорожка, TableOptions опции)

Указывает файл HTML, из которого должны быть извлечены таблицы HTML.

параметры

• путь - путь к файлу HTML, из которого извлекаются таблицы HTML.
  • необходимые
• TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.

Возвращаемое значение

аннулировать

TableOptions

Класс представляет все параметры, доступные при преобразовании таблиц HTML в CSV, XLSX или JSON.

Публичная недвижимость

• setCustomId(String value) - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали
  • По умолчанию: пусто
• setTableNumberToInclude(int value) - индекс таблицы, которую нужно преобразовать, если все таблицы на веб-странице упорядочены сверху вниз по веб-странице
  • По умолчанию: 1
• setFormat(TableFormat value) - формат таблицы должен быть в
  • По умолчанию: TableFormat.CSV
  • Опции: TableFormat.CSV, TableFormat.JSON, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - если в таблицу будут включены истинные имена заголовков
  • По умолчанию: правда
• setIncludeAllTables(boolean value) - если true, вся таблица на веб-странице будет извлечена, и каждая таблица появится в отдельном листе электронной таблицы. Доступно только с форматом XLSX
  • По умолчанию: false
• setTargetElement(String value) - идентификатор единственного HTML-элемента на веб-странице, который должен использоваться для извлечения таблиц из
  • По умолчанию: пусто
• setRequestAs(BrowserType value) - тип пользовательского агента, который вы хотите использовать
  • По умолчанию: BrowserType.STANDARDBROWSER
  • Опции: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.ПОИСКОВЫЙ ДВИЖОК
• setCountry(Country value) - страна скриншот должен быть взят из.
  • По умолчанию: текущее самое быстрое местоположение
  • Опции: Страна.СИНГАПУР, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.СОЕДИНЕННЫЕ ШТАТЫ
• setExportURL(String value) - URL экспорта это указывает, куда захват должен быть экспортирован тоже
  • По умолчанию: пусто
• setEncryptionKey(String key) - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
  • По умолчанию: пусто
• setAddress(String address) - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
  • По умолчанию: пусто
• setProxy(String proxy) - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
  • По умолчанию: пусто

Публичные методы

• AddPostParameter (String название, String стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
  • name - имя параметра HTTP Post
  • value - значение параметра HTTP Post

Save()

Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с GetResult метод.

Возвращаемое значение

Уникальный идентификатор скриншота, в противном случае, если произошла ошибка, генерируется исключение. Это можно использовать для получения скриншота с GetResult метод

Save(String CallBackURL)

Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с GetResult метод.

параметры

• callBackURL - обработчик Служба GrabzIt должна позвонить после завершения своей работы
  • необходимые

Возвращаемое значение

Уникальный идентификатор скриншота, в противном случае, если произошла ошибка, генерируется исключение. Это можно использовать для получения скриншота с GetResult метод

GrabzItFile SaveTo()

Save результат синхронно с GrabzItFile объект.

Возвращаемое значение

GrabzItFile объект

SaveTo(String saveToФайл)

Save результат синхронно в файл.

параметры

• saveToФайл - путь к файлу, который будет захвачен. saved, когда он будет завершен
  • необходимые

Возвращаемое значение

возвращает true, если он успешен, в противном случае выдается исключение.

Статус GetStatus (String Я бы)

Получить текущий статус скриншота GrabzIt.

параметры

• id - уникальный идентификатор скриншота
  • необходимые

Возвращаемое значение

Статус объект

GrabzItCookie [] GetCookies (String домен)

Получить все куки, которые GrabzIt использует для определенного домена. Это может также включать определенные пользователем файлы cookie.

параметры

• домен - домен для возврата куки
  • необходимые

Возвращаемое значение

GrabzItCookie массив

SetCookie (String название, String домен, String стоимость, String дорожка, boolean httponly, Дата истекает)

Устанавливает новый пользовательский файл cookie для GrabzIt, если пользовательский файл cookie имеет то же имя и домен, что и глобальный файл cookie, глобальный файл cookie переопределяется.

Это может быть полезно, если функциональность веб-сайта контролируется куки-файлами.

параметры

• name - имя куки для установки
  • необходимые
• домен - домен веб-сайта, для которого устанавливается файл cookie
  • необходимые
• value - значение куки
• путь - путь к сайту, к которому относится cookie
• httponly - если true, cookie может использоваться только с протоколом HTTP
• expires - определяет, когда истекает срок действия cookie. Передайте нулевое значение, если срок действия файла cookie не истек

Возвращаемое значение

True, если cookie успешно установлен, иначе false

DeleteCookie (String название, String домен)

Удалить пользовательский файл cookie или заблокировать использование глобального файла cookie

параметры

• name - имя куки для удаления
  • необходимые
• домен - домен сайта для удаления куки
  • необходимые

Возвращаемое значение

True, если cookie успешно удален, иначе false

WaterMark[] ПолучитьWaterMarks()

Получите все загруженные вами watermarks

Возвращаемое значение

WaterMark массив

WaterMark ПолучитьWaterMark(String идентификатор)

Верните свой заказ watermarks который соответствует указанному идентификатору

параметры

• идентификатор - идентификатор конкретного кастома watermark ты хочешь посмотреть
  • необходимые

Возвращаемое значение

WaterMark объект

ДобавитьWaterMark(String идентификатор, String дорожка, HorizontalPosition XPOS, VerticalPosition YPos)

Добавить новый обычай watermark

параметры

• идентификатор - идентификатор, который вы хотите присвоить пользовательскому watermark. Важно, чтобы этот идентификатор был уникальным.
  • необходимые
• path - абсолютный путь watermark на вашем сервере. Например, C: /watermark/1.png
  • необходимые
• xpos - горизонтальная позиция, в которой вы хотите, чтобы скриншот появлялся в
  • необходимые
  • Опции: HorizontalPosition.ОСТАВИЛ, HorizontalPosition.ЦЕНТР, HorizontalPosition.ПРАВИЛЬНО
• ypos - вертикальная позиция, в которой вы хотите, чтобы скриншот появлялся в
  • необходимые
  • Опции: VerticalPosition.ВВЕРХ, VerticalPosition.MIDDLE, VerticalPosition.НИЗ

Возвращаемое значение

возвращает истину, если watermark был успешно установлен

DeleteWaterMark(String идентификатор)

Удалить кастом watermark

параметры

• идентификатор - идентификатор кастомного watermark ты хочешь удалить
  • необходимые

Возвращаемое значение

возвращает истину, если watermark был успешно удален

SetLocalProxy (String proxyUrl)

Этот метод позволяет локальный прокси-сервер использоваться для всех запросов.

параметры

• proxyUrl - URL-адрес, который может включать порт прокси-сервера при необходимости. Предоставление нулевого значения удалит любой ранее установленный прокси
  • необходимые

UseSSL (boolean стоимость)

Определяет, если запросы к GrabzIt's API должен использовать SSL

параметры

• значение - если true, все запросы к API GrabzIt будут использовать SSL
  • необходимые

String CreateEncryptionKey ()

Создайте криптографически безопасный базовый ключ шифрования 64 длиной 44.

Расшифровать (String дорожка, String ключ)

Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.

параметры

• путь - путь зашифрованного захвата
  • необходимые
• ключ - ключ шифрования
  • необходимые

GrabzItFile Расшифровать (GrabzItFile файл, String ключ)

Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.

параметры

• файл - зашифрованный GrabzItFile
  • необходимые
• ключ - ключ шифрования
  • необходимые

byte [] Decrypt (byte [] data, String ключ)

Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.

параметры

• данные - зашифрованные байты
  • необходимые
• ключ - ключ шифрования
  • необходимые

Перечисления

ImageFormat

Это перечисление состоит из следующих значений.

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

BrowserType

Это перечисление состоит из следующих значений.

• STANDARDBROWSER
• мобильный браузер
• ПОИСКОВЫЙ ДВИЖОК

Страна

Это перечисление состоит из следующих значений.

• DEFAULT
• СИНГАПУР
• ВЕЛИКОБРИТАНИЯ
• СОЕДИНЕННЫЕ ШТАТЫ

PageSize

Это перечисление состоит из следующих значений.

• A3
• A4
• A5
• A6
• B3
• B4
• B5
• B6
• ЮРИДИЧЕСКАЯ
• ПИСЬМО

PageOrientation

Это перечисление состоит из следующих значений.

• ЛАНДШАФТ
• ПОРТРЕТ

CSSMediaType

Это перечисление состоит из следующих значений.

• ПЕЧАТЬ
• ЭКРАН

TableFormat

Это перечисление состоит из следующих значений.

• CSV
• JSON
• XSLX

HorizontalPosition

Это перечисление состоит из следующих значений.

• ЛЕВЫЙ
• ЦЕНТР
• ПРАВО

VerticalPosition

Это перечисление состоит из следующих значений.

• Топовый объект
• БЛИЖНИЙ
• BOTTOM

Классы результатов

печенье

Публичная недвижимость

• String getName()
  • Название куки.
• String getValue()
  • Значение cookie.
• String getDomain()
  • Домен, для которого установлен файл cookie.
• String getPath()
  • Путь в домене, к которому применяется этот файл cookie.
• String getHttpOnly()
  • Если этот файл cookie действителен только при просмотре веб-сайта по протоколу HTTP.
• String getExpires()
  • Дата истечения срока действия этого cookie
• String getType()
  • Тип cookie это может быть одним из следующих:
    • Global - это глобальный файл cookie, созданный GrabzIt
    • Local - это локальный файл cookie, установленный вами
    • Переопределено - глобальный файл cookie, который был переопределен вами

GrabzItFile

Публичные методы

• byte [] getBytes ()
• аннулировать Save(String путь)
• String вString()

Статус

Класс, представляющий текущий статус скриншота.

Публичные методы

• boolean isProcessing ()
  • Если это правда, скриншот все еще обрабатывается.
• boolean isCached ()
  • Если true, снимок экрана был обработан и в настоящее время кэширован.
• boolean isExpired ()
  • Если это правда, скриншот больше не находится в системе GrabzIt.
• String GetMessage ()
  • Сообщение об ошибке, возвращенное системой.

WaterMark

Этот класс представляет собой обычай watermarks хранится в GrabzIt

Публичные методы

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