Webをキャプチャして変換するツール

Rubyを使用したGrabzItクライアント

Ruby API

商品の説明

このクラスは、GrabzItスクリーンショットWebサービスとのすべての通信を処理します。

パブリックメソッド

get_result(id)

このメソッドは、スクリーンショット自体を返します。 何も返されない場合は、何かが間違っているか、スクリーンショットの準備がまだできていません。

パラメーター

戻り値

キャプチャ


url_to_animation(URL、 オプション = nil)

変換する必要のあるオンライン動画のURLを指定します intアニメーションGIF。

パラメーター

戻り値

ボイド

AnimationOptions

このクラスは、アニメーションGIFを作成するときに使用できるすべてのオプションを表します。

パブリックプロパティ


url_to_image(URL、 オプション = nil)

変換するURLを指定します int画像のスクリーンショット。

パラメーター

戻り値

ボイド

html_to_image(html、 オプション = nil)

変換するHTMLを指定します intoaイメージ。

パラメーター

戻り値

ボイド

file_to_image(パス、 オプション = nil)

変換するHTMLファイルを指定します intoaイメージ。

パラメーター

戻り値

ボイド

ImageOptions

このクラスは、画像キャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

パブリックメソッド


url_to_rendered_html(URL、 オプション = nil)

変換するURLを指定します intoレンダリングされたHTML。

パラメーター

戻り値

ボイド

html_to_rendered_html(html、 オプション = nil)

変換するHTMLを指定します intoレンダリングされたHTML。

パラメーター

戻り値

ボイド

file_to_rendered_html(パス、 オプション = nil)

変換するHTMLファイルを指定します intoレンダリングされたHTML。

パラメーター

戻り値

ボイド

HTMLOptions

クラスは、次の場合に利用可能なすべてのオプションを表します レンダリングされたHTMLキャプチャの作成.

パブリックプロパティ

パブリックメソッド


url_to_pdf(URL、 オプション = nil)

変換するURLを指定します intPDF

パラメーター

戻り値

ボイド

html_to_pdf(html、 オプション = nil)

変換するHTMLを指定します intPDF

パラメーター

戻り値

ボイド

file_to_pdf(パス、 オプション = nil)

変換するHTMLファイルを指定します intPDF

パラメーター

戻り値

ボイド

PDFOptions

このクラスは、PDFキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

パブリックメソッド


url_to_docx(URL、 オプション = nil)

変換するURLを指定します intDOCX。

パラメーター

戻り値

ボイド

html_to_docx(html、 オプション = nil)

変換するHTMLを指定します intDOCX。

パラメーター

戻り値

ボイド

file_to_docx(パス、 オプション = nil)

変換するHTMLファイルを指定します intDOCX。

パラメーター

戻り値

ボイド

DOCXOptions

このクラスは、DOCXキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

パブリックメソッド


url_to_table(URL、 オプション = nil)

HTMLテーブルの抽出元のURLを指定します。

パラメーター

戻り値

ボイド

html_to_table(html、 オプション = nil)

HTMLテーブルの抽出元のHTMLを指定します。

パラメーター

戻り値

ボイド

file_to_table(パス、 オプション = nil)

HTMLテーブルを抽出するHTMLファイルを指定します。

パラメーター

戻り値

ボイド

TableOptions

このクラスは、HTMLテーブルをCSV、XLSX、またはJSONに変換するときに使用可能なすべてのオプションを表します。

パブリックプロパティ

パブリックメソッド


これは、ファイルを保存するための推奨される方法です

save(callBackURL = nil)

Save 結果を非同期的に返し、一意の識別子を返します。これを使用して、スクリーンショットを取得します。 get_result 方法。

パラメーター

戻り値

それ以外の場合、スクリーンショットの一意の識別子。エラーが発生した場合、例外がスローされます。 これは、get_resultメソッドでスクリーンショットを取得するために使用できます


このメソッドは同期であるため、結果の処理中にアプリケーションが一時停止することを警告します

save_to()

Save スクリーンショットのバイトデータを含む変数に同期して結果を取得します。

戻り値

成功した場合はファイルのバイトデータを返し、そうでない場合は例外をスローします。


このメソッドは同期であるため、結果の処理中にアプリケーションが一時停止することを警告します

save_to(saveToファイル)

Save 結果をファイルに同期して。

パラメーター

戻り値

成功した場合はtrueを返し、そうでない場合は例外をスローします。


get_status(id)

GrabzItスクリーンショットの現在のステータスを取得します。

パラメーター

戻り値

ScreenShotStatus オブジェクト


get_cookies(ドメイン)

GrabzItが特定のドメインで使用しているすべてのCookieを取得します。 これには、ユーザー定義のCookieも含まれる場合があります。

パラメーター

戻り値

クッキー 配列


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

カスタムCookieがグローバルCookieと同じ名前とドメインを持っている場合、グローバルCookieは上書きされます。GrabzItに新しいカスタムCookieを設定します。

これは、Webサイトの機能がCookieによって制御されている場合に役立ちます。

パラメーター

戻り値

Cookieが正常に設定された場合はtrue、そうでない場合はfalse


delete_cookie(名前、ドメイン)

カスタムCookieを削除するか、グローバルCookieの使用をブロックします

パラメーター

戻り値

Cookieが正常に削除された場合はtrue、そうでない場合はfalse


取得する_watermarks()

アップロードしたカスタムを取得する watermarks

戻り値

WaterMark 配列


取得する_watermark(識別子)

アップロードしたカスタムを取得する watermarks

パラメーター

戻り値

WaterMark


追加_watermark(識別子、パス、xpos、ypos)

新しいカスタムを追加する watermark

パラメーター

戻り値

次の場合にtrueを返します watermark 正常に設定されました


削除_watermark(識別子)

カスタムを削除する watermark

パラメーター

戻り値

次の場合にtrueを返します watermark 正常に削除されました


set_local_proxy(value)

このメソッドにより、 ローカルプロキシサーバー すべてのリクエストに使用されます。

パラメーター


use_ssl(値)

GrabzItへのリクエストが APIはSSLを使用する必要があります

パラメーター


create_encryption_key()

暗号的に安全なベース64暗号化キー、44文字長を作成します。


復号化(データ、キー)

提供された暗号化キーを使用して、暗号化されたキャプチャを解読します。

パラメーター


decrypt_file(パス、キー)

提供された暗号化キーを使用して、暗号化されたキャプチャを解読します。

パラメーター


結果クラス

クッキー

パブリックプロパティ

ScreenShotStatus

スクリーンショットの現在のステータスを表すクラス。

パブリックプロパティ

WaterMark

このクラスはカスタムを表します watermarks GrabzItに保存

パブリックプロパティ