产品描述
此类处理与GrabzIt屏幕快照Web服务的所有通信。
公开方法
- get_result(id)
- url_to_animation(url, options)
- url_to_image(url, options)
- html_to_image(html, options)
- file_to_image(path, options)
- url_to_pdf(url, options)
- html_to_pdf(html, options)
- file_to_pdf(path, options)
- url_to_docx(url, options)
- html_to_docx(html, options)
- file_to_docx(path, options)
- url_to_table(url, options)
- html_to_table(html, options)
- file_to_table(path, options)
- url_to_rendered_html(url, options)
- html_to_rendered_html(html, options)
- file_to_rendered_html(path, options)
- save(callBackUrl, oncomplete)
- save_to(saveToFile, oncomplete)
- get_status(id, oncomplete)
- get_cookies(domain, oncomplete)
- set_cookie(name, domain, options, oncomplete)
- delete_cookie(name, domain, oncomplete)
- get_watermarks(oncomplete)
- get_watermark(identifier, oncomplete)
- add_watermark(identifier, path, xpos, ypos, oncomplete)
- delete_watermark(identifier, oncomplete)
- set_local_proxy(value)
- use_ssl(value)
- create_encryption_key()
- decrypt(data, key)
- decrypt_file(path, key, oncomplete)
get_result(id)
此方法返回屏幕快照本身。 如果未返回任何内容,则说明出现问题或屏幕截图尚未准备好。
参数
url_to_animation(网址, 选项)
指定应转换的在线视频的URL int动画GIF。
参数
-
url-要转换的在线视频的URL into动画GIF
- 其他要求
-
接受Vimeo和YouTube视频URL
- 对Vimeo和YouTube视频进行动画制作的警告取决于第三方,因此可能无法提供一致的结果。
- 选项 -一个JSON对象,定义了创建动画GIF时要使用的任何特殊选项。
回报值
无效
动画选项
创建动画GIF时所有可用的选项。
-
customId -您可以传递给动画GIF Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
width -生成的动画GIF的宽度(以像素为单位)。
- 默认值:180px
- 最大:包装的最大宽度
- 自动调整大小:-1 (传递-1表示 动画GIF缩放 关于其高度,如果宽度是自动调整大小,则高度不能)
-
height -生成的动画GIF的高度(以像素为单位)。
- 默认值:120px
- 最大:包装的最大高度
- 自动调整大小:-1 (传递-1表示 动画GIF缩放 关于宽度,如果要自动调整高度,则宽度不能)
-
start -应该转换的视频的起始位置 int动画GIF。
-
duration -应该转换的视频的长度(以秒为单位) int动画GIF。
-
speed -动画GIF的速度。
-
framesPerSecond -每秒应从视频中捕获的帧数。
-
repeat -循环播放动画GIF的次数。
-
reverse -如果为true,则动画GIF的帧反转
-
customWaterMarkId -添加自定义 watermark 到动画GIF
-
quality - 返回图像的质量,其默认压缩率为85%。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
country - 国家 动画GIF应该取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
选项示例
{
'width':250,
'height':250,
'speed':2
}
url_to_image(网址, 选项)
指定应转换的URL intoa图像截图。
参数
-
url-屏幕快照的URL
- 选项 -一个JSON对象,定义了创建屏幕快照时要使用的任何特殊选项。
回报值
无效
html_to_image(html, 选项)
指定应转换的HTML intoa图像。
参数
-
html- 要转换的HTML intoa图片
- 选项 -一个JSON对象,定义创建图像时要使用的任何特殊选项。
回报值
无效
file_to_image(路径, 选项)
指定应转换的HTML文件 intoa图像。
参数
-
path-要转换的HTML文件的文件路径 intoa图片
- 选项 -一个JSON对象,定义创建图像时要使用的任何特殊选项。
回报值
无效
图片选项
创建图像捕获时所有可用的选项。
-
customId -您可以传递给屏幕截图Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
browserWidth -浏览器的宽度(以像素为单位)
-
browserHeight -浏览器的高度(以像素为单位)
- 默认值:1170
- 最大:10000
- 全长:-1 (传递-1表示获取整个网页的截图)
-
width -结果缩略图的宽度(以像素为单位)
- 默认值:如果未同时指定输出宽度和输出高度或为0,则输出宽度和高度将与最终图像的宽度和高度相匹配;如果指定了输出高度,则输出宽度将与输出高度成比例
- 最大:包装的最大宽度
- 全宽:-1 (传递-1表示缩略图的宽度不会减小)
-
height -结果缩略图的高度,以毫米为单位
- 默认值:如果未同时指定输出宽度和输出高度或为0,则输出宽度和高度将与最终图像的宽度和高度相匹配;如果指定了输出宽度,则输出高度将与输出宽度成比例
- 最大:包装的最大高度
- 全高:-1 (传递-1表示缩略图的高度不会减小)
-
format -屏幕截图应采用的格式。
- 默认值:“ jpg”
- 选项:“ bmp8”,“ bmp16”,“ bmp24”,“ bmp”,“ tiff”,“ webp”,“ jpg”,“ png”
-
delay -的毫秒数 等待截图之前
-
clickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
targetElement - CSS选择器 目标网页上唯一要翻转的HTML元素 int在屏幕截图中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
-
hideElement - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
waitForElement - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
requestAs -您希望使用的用户代理类型
- 默认值:0
-
选项:
- 0 =指示应使用标准浏览器的用户代理
- 1 =指示应使用移动浏览器的用户代理
- 2 =表示应使用搜索引擎的用户代理
-
customWaterMarkId -添加自定义 watermark 对图像
-
quality - 返回图像的质量。 目前,这仅会影响JPG和WEBP图像,它们的默认压缩率为90%。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
transparent -如果为true 图像捕获应该是透明的。 这仅与png和tiff图像兼容。
-
hd -如果图像真实 捕获将是高清 这会使图像尺寸增加一倍。
-
country - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
noAds - 如果属实 广告应自动隐藏.
-
noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
address -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
post -定义HTTP Post查询string。 查询中的每个名称和值string 将需要进行URL编码。 使用此选项将强制GrabzIt 执行HTTP发布.
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
选项示例
{
'width':500,
'height':500
}
url_to_rendered_html(网址, 选项)
指定应转换的URL into呈现HTML。
参数
-
url-呈现HTML的URL
- 选项 -一个JSON对象,它定义在创建呈现的HTML时要使用的任何特殊选项。
回报值
无效
html_to_rendered_html(html, 选项)
指定应转换的HTML into呈现HTML。
参数
-
html- 要转换的HTML into呈现的HTML
- 选项 -一个JSON对象,定义创建渲染HTML时要使用的任何特殊选项。
回报值
无效
file_to_rendered_html(路径, 选项)
指定应转换的HTML文件 into呈现HTML。
参数
-
path-要转换的HTML文件的文件路径 into呈现的HTML
- 选项 -一个JSON对象,定义创建渲染HTML时要使用的任何特殊选项。
回报值
无效
HTML选项
所有可用选项 创建渲染的HTML捕获.
-
customId -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
browserWidth -浏览器的宽度(以像素为单位)
-
browserHeight -浏览器的高度(以像素为单位)
-
delay -的毫秒数 等待截图之前
-
clickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
waitForElement - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
requestAs -您希望使用的用户代理类型
- 默认值:0
-
选项:
- 0 =指示应使用标准浏览器的用户代理
- 1 =指示应使用移动浏览器的用户代理
- 2 =表示应使用搜索引擎的用户代理
-
country - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
noAds - 如果属实 广告应自动隐藏.
-
noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
address -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
post -定义HTTP Post查询string。 查询中的每个名称和值string 将需要进行URL编码。 使用此选项将强制GrabzIt 执行HTTP发布.
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
选项示例
{
'country':'SG',
'delay':5000
}
url_to_pdf(网址, 选项)
指定应转换的URL intoa PDF。
参数
-
url-应该转换的网址 int一份PDF
- 选项 -一个JSON对象,定义创建PDF时要使用的任何特殊选项。
回报值
无效
html_to_pdf(html, 选项)
指定应转换的HTML intoa PDF。
参数
-
html- 要转换的HTML int一份PDF
- 选项 -一个JSON对象,定义创建PDF时要使用的任何特殊选项。
回报值
无效
file_to_pdf(路径, 选项)
指定应转换的HTML文件 intoa PDF。
参数
-
path-要转换的HTML文件的文件路径 int一份PDF
- 选项 -一个JSON对象,定义创建PDF时要使用的任何特殊选项。
回报值
无效
PDF选项
创建PDF捕获时所有可用的选项。
-
customId -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
includeBackground -如果为true,则屏幕截图中应包含网页背景
-
pagesize -PDF的页面大小
- 默认值:“ A4”
- 选项:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
-
orientation -PDF文件的方向
-
cssMediaType - PDF文档的CSS媒体类型
- 默认值:“屏幕”
- 选项:“屏幕”,“ Print"
-
includeLinks -如果链接应包含在PDF中,则为true
-
includeOutline -如果为真 PDF书签 应该包括在内
-
title -提供PDF文档的标题
-
coverUrl -应该用作PDF封面的网页的网址
-
marginTop -应出现在PDF文档页面顶部的以毫米为单位的边距
-
marginLeft -应在PDF文档页面左侧显示的以毫米为单位的边距
-
marginBottom -应在PDF文档页面底部显示的以毫米为单位的边距
-
marginRight -PDF文档右侧应出现的以毫米为单位的边距
-
browserWidth - 浏览器的宽度 以像素为单位
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
- 默认值:1366
- 最大:10000
- 自动宽度:-1 (传递-1表示浏览器的宽度与PDF文档的宽度匹配)
-
pageWidth - 生成的PDF的自定义宽度 单位为毫米
-
pageHeight - 生成的PDF的自定义高度 单位为毫米
-
delay -的毫秒数 等待截图之前
-
requestAs -您希望使用的用户代理类型
- 默认值:0
-
选项:
- 0 =指示应使用标准浏览器的用户代理
- 1 =指示应使用移动浏览器的用户代理
- 2 =表示应使用搜索引擎的用户代理
-
templateId -添加一个 模板 指定PDF文档的页眉和页脚的ID
-
clickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
targetElement - CSS选择器 唯一的 目标网页上将要打开的HTML元素 int一份PDF,网页的所有其他部分都将被忽略。 如果有多个匹配的HTML元素,则选择第一个
-
hideElement - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
waitForElement - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
customWaterMarkId -添加自定义 watermark 到PDF文档的每一页
-
quality - 返回的PDF的质量。 默认使用PDF的推荐质量。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
country - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
noAds - 如果属实 广告应自动隐藏.
-
noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
address -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
post -定义HTTP Post查询string。 查询中的每个名称和值string 将需要进行URL编码。 使用此选项将强制GrabzIt 执行HTTP发布.
-
templateVariables -定义一个 自定义模板 参数和值作为查询string。 查询中的每个名称和值string 将需要进行URL编码。
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
-
mergeId -捕获的ID,应为 在新的PDF文档的开头合并
-
password - 保护PDF文档的密码 和
选项示例
{
'pagesize':'A5',
'includeLinks':true
}
url_to_docx(网址, 选项)
指定应转换的URL int或DOCX。
参数
-
url-应该转换的网址 intDOCX
- 选项 -一个JSON对象,定义创建DOCX时要使用的任何特殊选项。
回报值
无效
html_to_docx(html, 选项)
指定应转换的HTML int或DOCX。
参数
-
html- 要转换的HTML intDOCX
- 选项 -一个JSON对象,定义创建DOCX时要使用的任何特殊选项。
回报值
无效
file_to_docx(路径, 选项)
指定应转换的HTML文件 int或DOCX。
参数
-
path-要转换的HTML文件的文件路径 intDOCX
- 选项 -一个JSON对象,定义创建DOCX时要使用的任何特殊选项。
回报值
无效
DOCX选项
创建DOCX捕获时所有可用的选项。
-
customId -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
includeBackground -如果为true,则网页的背景图片应包含在DOCX中
-
pagesize -DOCX的页面大小
- 默认值:“ A4”
- 选项:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
-
orientation -DOCX文档的方向
-
includeLinks -如果链接应包含在DOCX中,则为true
-
includeImages -如果为true,则网页图像应包含在DOCX中
-
title -提供DOCX文档的标题
-
marginTop -应在DOCX文档页面顶部显示的以毫米为单位的边距
-
marginLeft -应在DOCX文档页面左侧显示的以毫米为单位的边距
-
marginBottom -应在DOCX文档页面底部显示的以毫米为单位的边距
-
marginRight -DOCX文档右侧应出现的以毫米为单位的边距
-
browserWidth - 浏览器的宽度 以像素为单位
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
- 默认值:1366
- 最大:10000
- 自动宽度:-1 (传递-1表示浏览器的宽度与DOCX文档的宽度匹配)
-
pageWidth - 生成的DOCX的自定义宽度 单位为毫米
-
pageHeight - 生成的DOCX的自定义高度 单位为毫米
-
delay -的毫秒数 等待截图之前
-
requestAs -您希望使用的用户代理类型
- 默认值:0
-
选项:
- 0 =指示应使用标准浏览器的用户代理
- 1 =指示应使用移动浏览器的用户代理
- 2 =表示应使用搜索引擎的用户代理
-
templateId -添加一个 模板 指定DOCX文档的页眉和页脚的ID
-
clickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
targetElement - CSS选择器 目标网页上唯一要翻转的HTML元素 int在DOCX中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
-
hideElement - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
waitForElement - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
quality - 返回的DOCX的质量。 DOCX中图像的默认质量为85%。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
country - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
noAds - 如果属实 广告应自动隐藏.
-
noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
address -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
post -定义HTTP Post查询string。 查询中的每个名称和值string 将需要进行URL编码。 使用此选项将强制GrabzIt 执行HTTP发布.
-
templateVariables -定义一个 自定义模板 参数和值作为查询string。 查询中的每个名称和值string 将需要进行URL编码。
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
-
mergeId -捕获的ID,应为 在新的DOCX文档的开头合并
-
password - 保护DOCX文档的密码 和
选项示例
{
'pagesize':'A5',
'includeLinks':true
}
url_to_table(网址, 选项)
指定应从中提取HTML表的URL。
参数
-
url-从中提取HTML表的URL
- 选项 -一个JSON对象,它定义转换HTML表时要使用的任何特殊选项。
回报值
无效
html_to_table(html, 选项)
指定应从中提取HTML表的HTML。
参数
-
html-从中提取HTML表的HTML。
- 选项 -一个JSON对象,它定义转换HTML表时要使用的任何特殊选项。
回报值
无效
file_to_table(路径, 选项)
指定应从中提取HTML表的HTML文件。
参数
-
path-从中提取HTML表的HTML文件的文件路径。
- 选项 -一个JSON对象,它定义转换HTML表时要使用的任何特殊选项。
回报值
无效
表格选项
将HTML表转换为CSV,XLSX或JSON时,所有可用选项。
-
customId -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回
-
tableNumberToInclude -要转换的表的索引,即网页中的所有表从网页顶部到底部的顺序
-
format -表格应采用的格式
- 默认值:“ csv”
- 选项:“ csv”,“ json”,“ xlsx”
-
includeHeaderNames -如果表中包含真实的标题名称
-
includeAllTables -如果为true,则将提取网页上的所有表格,并且每个表格都显示在单独的电子表格中。 仅适用于XLSX格式
-
targetElement -网页中唯一可用于从中提取表格的HTML元素的ID
-
requestAs -您希望使用的用户代理类型
- 默认值:0
-
选项:
- 0 =指示应使用标准浏览器的用户代理
- 1 =指示应使用移动浏览器的用户代理
- 2 =表示应使用搜索引擎的用户代理
-
country - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项:“ SG”,“ UK”,“ US”
-
exportUrl - 导出网址 指定捕获也应导出到的位置
-
encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
post -定义HTTP Post查询string。 查询中的每个名称和值string 将需要进行URL编码。 使用此选项将强制GrabzIt 执行HTTP发布.
-
address -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
proxy - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
选项示例
{
'format':'xlsx',
'includeHeaderNames':true
}
建议使用callBackUrl选项保存文件
save(callBackUrl,未完成)
Save 异步返回结果,并返回唯一的标识符,该标识符可用于获取带有 get_result 方法。
参数
- callBackURL- 处理器 GrabzIt服务应在完成工作后致电
- oncomplete(error,id)-回调函数,当获取屏幕快照的id时调用。
save_to(saveTo文件,未完成)
Save 同步结果,而不使用回调URL。
参数
- saveToFile-捕获的文件路径 saved至完成后
- oncomplete(错误,数据)-回调函数,在下载屏幕截图时调用。 data参数包含屏幕截图字节。
get_status(编号,未完成)
获取GrabzIt屏幕快照的当前状态。
参数
-
id-屏幕截图的唯一标识符
-
未完成(错误, 状态)-回调函数,在获取屏幕快照状态时调用。
get_cookies(域,未完成)
获取所有GrabzIt用于特定域的cookie。 这也可能包括用户定义的cookie。
参数
-
域-要为其返回Cookie的域
-
未完成(错误, 曲奇饼)-回调函数,当已获取cookie时调用。
set_cookie(名称,域,选项,完成)
在GrabzIt上设置一个新的自定义cookie,如果该自定义cookie与全局cookie具有相同的名称和域,则将覆盖全局cookie。
如果网站功能由Cookie控制,这将很有用。
参数
delete_cookie(名称,域,未完成)
删除自定义cookie或阻止全局cookie被使用
参数
-
name-要删除的Cookie的名称
-
域-要删除其Cookie的网站的域
- oncomplete(错误,成功)-回调函数,在设置cookie时调用。 如果删除cookie,则成功参数为true,否则为false。
得到_watermarks()
获取所有上传的自定义 watermarks
参数
-
未完成(错误, watermarks)-回调函数,当 watermarks 已被检索。 的 watermark 参数包含一个数组 watermarks.
得到_watermark(标识符,未完成)
返回您的习惯 watermark 与指定的标识符匹配
参数
-
标识符-特定习惯的标识符 watermark 你想查看
-
未完成(错误, watermarks)-回调函数,当 watermark 已被检索。 的 watermarks 参数包含一个 watermark 数组。
加_watermark(标识符,路径,xpos,ypos,oncomplete)
添加新的自定义 watermark
参数
-
标识符-您要赋予自定义的标识符 watermark。 此标识符是唯一的,这一点很重要。
-
path-的绝对路径 watermark 在您的服务器上。 例如C:/watermark/1.png
-
xpos-您希望屏幕截图出现在的水平位置
-
ypos-您希望屏幕截图出现在的垂直位置
-
oncomplete(错误,成功)-回调函数,当 watermark 已添加。 如果参数为true,则成功参数为true watermark 已成功添加蜜蜂,否则为false。
删除_watermark(标识符,未完成)
删除自定义 watermark
参数
-
标识符-海关的标识符 watermark 您要删除
-
oncomplete(错误,成功)-回调函数,当 watermark 已被删除。 如果成功参数为true watermark 已成功删除。
set_local_proxy(值)
此方法启用 本地代理服务器 用于所有请求。
参数
-
value-代理的URL,如果需要,可以包含端口。 提供空值将删除任何先前设置的代理
use_ssl(值)
指定是否向GrabzIt发出请求 API应该使用SSL
参数
-
值-如果为true,则对GrabzIt API的所有请求都将使用SSL
create_encryption_key()
创建一个加密安全的基本64加密密钥,长度为44个字符。
解密(数据,密钥)
使用提供的加密密钥对加密的捕获进行解密。
参数
crypto_file(路径,密钥,未完成)
使用提供的加密密钥对加密的捕获进行解密。
参数
-
path-加密捕获的路径
-
关键- 加密金钥
- oncomplete(error)-回调函数,在解密文件时调用。
结果类
Cookies
公共变量
- 名称-Cookie名称
- 值-Cookie值
- 域-设置Cookie的域
- path-此Cookie应用于的域上的路径。
- httponly-如果此cookie仅在使用HTTP协议查看网站时有效。
- 过期-此Cookie过期的日期
-
type-这是Cookie的类型
-
选项:
- 全局-这是GrabzIt设置的全局cookie
- 本地-这是您设置的本地Cookie
- 已覆盖-已被您覆盖的全局cookie
Status
表示屏幕快照当前状态的类。
公共变量
- 处理-如果为true,则仍在处理屏幕截图。
- 已缓存-如果为true,则屏幕快照已被处理并且当前已缓存。
- 已过期-如果为true,则屏幕截图不再在GrabzIt系统上。
- message-系统返回的错误消息。
WaterMark
此类代表风俗习惯 watermarks 存储在GrabzIt中
公共变量
- 标识符-的标识符 watermark
- 格式-的格式 watermark 图片
-
xPosition-的x位置 watermark 出现在屏幕截图上
-
yPosition-的y位置 watermark 出现在屏幕截图上