Инструменты для захвата и конвертирования Интернета

GrabzIt Клиент с Рубином

Ruby API

Описание

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

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

get_result (ID)

Этот метод возвращает сам скриншот. Если ничего не возвращено, значит что-то пошло не так или скриншот еще не готов.

параметры

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

Захват


url_to_animation(URL, опционы = ноль)

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

параметры

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

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

AnimationOptions

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

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


url_to_image(URL, опционы = ноль)

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

параметры

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

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

html_to_image(HTML, опционы = ноль)

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

параметры

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

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

file_to_image(дорожка, опционы = ноль)

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

параметры

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

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

ImageOptions

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

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

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


url_to_rendered_html(URL, опционы = ноль)

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

параметры

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

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

html_to_rendered_html(HTML, опционы = ноль)

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

параметры

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

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

file_to_rendered_html(дорожка, опционы = ноль)

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

параметры

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

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

HTMLOptions

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

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

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


url_to_pdf(URL, опционы = ноль)

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

параметры

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

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

html_to_pdf(HTML, опционы = ноль)

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

параметры

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

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

file_to_pdf(дорожка, опционы = ноль)

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

параметры

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

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

PDFOptions

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

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

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


url_to_docx(URL, опционы = ноль)

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

параметры

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

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

html_to_docx(HTML, опционы = ноль)

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

параметры

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

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

file_to_docx(дорожка, опционы = ноль)

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

параметры

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

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

DOCXOptions

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

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

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


url_to_table(URL, опционы = ноль)

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

параметры

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

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

html_to_table(HTML, опционы = ноль)

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

параметры

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

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

file_to_table(дорожка, опционы = ноль)

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

параметры

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

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

TableOptions

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

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

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


Это рекомендуемый метод сохранения файла

save(callBackURL = ноль)

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

параметры

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

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


Предупреждение: этот метод является синхронным, поэтому приложение будет приостановлено во время обработки результата

save_to()

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

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

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


Предупреждение: этот метод является синхронным, поэтому приложение будет приостановлено во время обработки результата

save_to(saveToФайл)

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

параметры

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

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


get_status(Я бы)

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

параметры

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

ScreenShotStatus объект


get_cookies(домен)

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

параметры

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

печенье массив


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

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

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

параметры

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

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


delete_cookie (имя, домен)

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

параметры

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

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


получить_watermarks()

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

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

WaterMark массив


получить_watermark(идентификатор)

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

параметры

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

WaterMark


Добавить_watermark(идентификатор, путь, xpos, ypos)

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

параметры

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

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


удалять_watermark(идентификатор)

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

параметры

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

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


set_local_proxy (значение)

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

параметры


USE_SSL (значение)

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

параметры


create_encryption_key ()

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


расшифровать (данные, ключ)

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

параметры


decrypt_file (путь, ключ)

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

параметры


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

печенье

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

ScreenShotStatus

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

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

WaterMark

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

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