捕获和转换Web的工具

GrabzIt Client与Ruby

Ruby API

产品介绍

此类处理与GrabzIt屏幕快照Web服务的所有通信。

公开方法

get_result(id)

此方法返回屏幕快照本身。 如果未返回任何内容,则说明出现问题或屏幕截图尚未准备好。

参数

回报值

捕获


url_to_animation(网址, 选项 =无)

指定应转换的在线视频的URL int动画GIF。

参数

回报值

无效

AnimationOptions

该类表示创建动画GIF时所有可用的选项。

公共财产


url_to_image(网址, 选项 =无)

指定应转换的URL intoa图像截图。

参数

回报值

无效

html_to_image(html, 选项 =无)

指定应转换的HTML intoa图像。

参数

回报值

无效

file_to_image(路径, 选项 =无)

指定应转换的HTML文件 intoa图像。

参数

回报值

无效

ImageOptions

该类表示创建图像捕获时所有可用的选项。

公共财产

公开方法


url_to_rendered_html(网址, 选项 =无)

指定应转换的URL into呈现HTML。

参数

回报值

无效

html_to_rendered_html(html, 选项 =无)

指定应转换的HTML into呈现HTML。

参数

回报值

无效

file_to_rendered_html(路径, 选项 =无)

指定应转换的HTML文件 into呈现HTML。

参数

回报值

无效

HTMLOptions

该类表示在以下情况下所有可用的选项 创建渲染的HTML捕获.

公共财产

公开方法


url_to_pdf(网址, 选项 =无)

指定应转换的URL intoa PDF。

参数

回报值

无效

html_to_pdf(html, 选项 =无)

指定应转换的HTML intoa PDF。

参数

回报值

无效

file_to_pdf(路径, 选项 =无)

指定应转换的HTML文件 intoa PDF。

参数

回报值

无效

PDF选项

该类表示创建PDF捕获时所有可用的选项。

公共财产

公开方法


url_to_docx(网址, 选项 =无)

指定应转换的URL int或DOCX。

参数

回报值

无效

html_to_docx(html, 选项 =无)

指定应转换的HTML int或DOCX。

参数

回报值

无效

file_to_docx(路径, 选项 =无)

指定应转换的HTML文件 int或DOCX。

参数

回报值

无效

DOCXOptions

该类表示创建DOCX捕获时所有可用的选项。

公共财产

公开方法


url_to_table(网址, 选项 =无)

指定应从中提取HTML表的URL。

参数

回报值

无效

html_to_table(html, 选项 =无)

指定应从中提取HTML表的HTML。

参数

回报值

无效

file_to_table(路径, 选项 =无)

指定应从中提取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屏幕快照的当前状态。

参数

回报值

屏幕截图状态 对象


get_cookies(域)

获取所有GrabzIt用于特定域的cookie。 这也可能包括用户定义的cookie。

参数

回报值

饼干 排列


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

在GrabzIt上设置一个新的自定义cookie,如果该自定义cookie与全局cookie具有相同的名称和域,则将覆盖全局cookie。

如果网站功能由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(值)

此方法启用 本地代理服务器 用于所有请求。

参数


use_ssl(值)

指定是否向GrabzIt发出请求 API应该使用SSL

参数


create_encryption_key()

创建一个加密安全的基本64加密密钥,长度为44个字符。


解密(数据,密钥)

使用提供的加密密钥对加密的捕获进行解密。

参数


crypto_file(路径,密钥)

使用提供的加密密钥对加密的捕获进行解密。

参数


结果类

饼干

公共财产

屏幕截图状态

表示屏幕快照当前状态的类。

公共财产

WaterMark

此类代表风俗习惯 watermarks 存储在GrabzIt中

公共财产