捕获和转换Web的工具

使用Node.js的GrabzIt客户端Node.js API

產品描述

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

公开方法

get_result(id)

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

参数

  • 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。
    • 默认值:0秒
  • duration -应该转换的视频的长度(以秒为单位) int动画GIF。
    • 默认值:包装的最大长度
  • speed -动画GIF的速度。
    • 默认值:1
    • 最低:0.2
    • 最大:10
  • framesPerSecond -每秒应从视频中捕获的帧数。
    • 默认值:10
    • 最低:0.2
    • 最大:60
  • repeat -循环播放动画GIF的次数。
    • 默认值:0
    • 连续循环:0
  • reverse -如果为true,则动画GIF的帧反转
    • 默认值:false
  • customWaterMarkId -将自定义水印添加到动画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 -浏览器的宽度(以像素为单位)
    • 默认值:1024
    • 最大:10000
  • browserHeight -浏览器的高度(以像素为单位)
    • 默认值:768
    • 最大:10000
    • 全长:-1 (传递-1表示获取整个网页的截图)
  • width -结果缩略图的宽度(以像素为单位)
    • 默认值:浏览器宽度的最高比例,可能适合用户包的最大宽度
    • 最大:包装的最大宽度
    • 全宽:-1 (传递-1表示缩略图的宽度不会减小)
  • height -结果缩略图的高度,以毫米为单位
    • 默认值:浏览器高度的最大比例,该比例适合用户包的最大高度
    • 最大:包装的最大高度
    • 全高:-1 (传递-1表示缩略图的高度不会减小)
  • format -屏幕截图应采用的格式。
    • 默认值:“ jpg”
    • 选项:“ bmp8”,“ bmp16”,“ bmp24”,“ bmp”,“ tiff”,“ webp”,“ jpg”,“ png”
  • delay -的毫秒数 等待截图之前
    • 默认值:0
    • 最大:30000
  • targetElement -id或class CSS选择器 目标网页上唯一要翻转的HTML元素 int在屏幕截图中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
    • 默认值:空
  • hideElement -id或class CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
    • 默认值:空
  • waitForElement -id或class CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
    • 默认值:空
  • requestAs -您希望使用的用户代理类型
    • 默认值:0
    • 选项:
      • 0 =指示应使用标准浏览器的用户代理
      • 1 =指示应使用移动浏览器的用户代理
      • 2 =表示应使用搜索引擎的用户代理
      • 3 =表示应使用基本浏览器的用户代理
  • customWaterMarkId -向图像添加自定义水印
    • 默认值:空
  • quality - 返回图像的质量。 目前,这仅会影响JPG图像,其默认压缩率为85%。
    • 降低质量会减少文件大小并减少下载时间。
    • 默认值:-1
    • 最低:-1
    • 最大:100
  • transparent -如果为true 图像捕获应该是透明的。 这仅与png和tiff图像兼容。
    • 默认值:false
  • hd -如果图像真实 捕获将是高清 这会使图像尺寸增加一倍。
    • 默认值:false
  • country - 国家 屏幕截图应取自。
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:当前最快的位置
    • 选项:“ SG”,“ UK”,“ US”
  • exportURL - 导出网址 指定捕获也应导出到的位置
    • 默认值:空
  • encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
    • 默认值:空
  • noAds - 如果属实 广告应自动隐藏.
    • 默认值:false
  • noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
    • 默认值:false
  • 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 -浏览器的宽度(以像素为单位)
    • 默认值:1024
    • 最大:10000
  • browserHeight -浏览器的高度(以像素为单位)
    • 默认值:768
    • 最大:10000
  • delay -的毫秒数 等待截图之前
    • 默认值:0
    • 最大:30000
  • waitForElement -id或class CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
    • 默认值:空
  • requestAs -您希望使用的用户代理类型
    • 默认值:0
    • 选项:
      • 0 =指示应使用标准浏览器的用户代理
      • 1 =指示应使用移动浏览器的用户代理
      • 2 =表示应使用搜索引擎的用户代理
      • 3 =表示应使用基本浏览器的用户代理
  • country - 国家 屏幕截图应取自。
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:当前最快的位置
    • 选项:“ SG”,“ UK”,“ US”
  • exportURL - 导出网址 指定捕获也应导出到的位置
    • 默认值:空
  • encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
    • 默认值:空
  • noAds - 如果属实 广告应自动隐藏.
    • 默认值:false
  • noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
    • 默认值:false
  • 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,则屏幕截图中应包含网页背景
    • 默认值:true
  • pagesize -PDF的页面大小
    • 默认值:“ A4”
    • 选项:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
  • orientation -PDF文件的方向
    • 默认值:“肖像”
    • 选项:“纵向”,“横向”
  • cssMediaType - PDF文档的CSS媒体类型
    • 默认值:“屏幕”
    • 选项:“屏幕”,“ Print"
  • includeLinks -如果链接应包含在PDF中,则为true
    • 默认值:true
  • includeOutline -如果为真 PDF书签 应该包括在内
    • 默认值:false
  • title -提供PDF文档的标题
    • 默认值:空
  • coverURL -应该用作PDF封面的网页的网址
    • 默认值:空
  • marginTop -应出现在PDF文档页面顶部的以毫米为单位的边距
    • 默认值:10
  • marginLeft -应在PDF文档页面左侧显示的以毫米为单位的边距
    • 默认值:10
  • marginBottom -应在PDF文档页面底部显示的以毫米为单位的边距
    • 默认值:10
  • marginRight -PDF文档右侧应出现的以毫米为单位的边距
    • 默认值:10
  • browserWidth - 浏览器的宽度 以像素为单位
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:1024
    • 最大:10000
    • 自动宽度:-1 (传递-1表示浏览器的宽度与PDF文档的宽度匹配)
  • pageWidth - 生成的PDF的自定义宽度 单位为毫米
  • pageHeight - 生成的PDF的自定义高度 单位为毫米
  • delay -的毫秒数 等待截图之前
    • 默认值:0
    • 最大:30000
  • requestAs -您希望使用的用户代理类型
    • 默认值:0
    • 选项:
      • 0 =指示应使用标准浏览器的用户代理
      • 1 =指示应使用移动浏览器的用户代理
      • 2 =表示应使用搜索引擎的用户代理
      • 3 =表示应使用基本浏览器的用户代理
  • templateId -添加一个 模板 指定PDF文档的页眉和页脚的ID
    • 默认值:空
  • targetElement -id或class CSS选择器 目标网页上唯一要翻转的HTML元素 int在PDF中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
    • 默认值:空
  • hideElement -id或class CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
    • 默认值:空
  • waitForElement -id或class CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
    • 默认值:空
  • customWaterMarkId -在PDF文档的每一页上添加自定义水印
    • 默认值:空
  • quality - 返回的PDF的质量。 默认使用PDF的推荐质量。
    • 降低质量会减少文件大小并减少下载时间。
    • 默认值:-1
    • 最低:-1
    • 最大:100
  • country - 国家 屏幕截图应取自。
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:当前最快的位置
    • 选项:“ SG”,“ UK”,“ US”
  • exportURL - 导出网址 指定捕获也应导出到的位置
    • 默认值:空
  • encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
    • 默认值:空
  • noAds - 如果属实 广告应自动隐藏.
    • 默认值:false
  • noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
    • 默认值:false
  • 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中
    • 默认值:true
  • pagesize -DOCX的页面大小
    • 默认值:“ A4”
    • 选项:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
  • orientation -DOCX文档的方向
    • 默认值:“肖像”
    • 选项:“纵向”,“横向”
  • includeLinks -如果链接应包含在DOCX中,则为true
    • 默认值:true
  • includeImages -如果为true,则网页图像应包含在DOCX中
    • 默认值:true
  • title -提供DOCX文档的标题
    • 默认值:空
  • marginTop -应在DOCX文档页面顶部显示的以毫米为单位的边距
    • 默认值:10
  • marginLeft -应在DOCX文档页面左侧显示的以毫米为单位的边距
    • 默认值:10
  • marginBottom -应在DOCX文档页面底部显示的以毫米为单位的边距
    • 默认值:10
  • marginRight -DOCX文档右侧应出现的以毫米为单位的边距
    • 默认值:10
  • browserWidth - 浏览器的宽度 以像素为单位
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:1024
    • 最大:10000
    • 自动宽度:-1 (传递-1表示浏览器的宽度与DOCX文档的宽度匹配)
  • pageWidth - 生成的DOCX的自定义宽度 单位为毫米
  • pageHeight - 生成的DOCX的自定义高度 单位为毫米
  • delay -的毫秒数 等待截图之前
    • 默认值:0
    • 最大:30000
  • requestAs -您希望使用的用户代理类型
    • 默认值:0
    • 选项:
      • 0 =指示应使用标准浏览器的用户代理
      • 1 =指示应使用移动浏览器的用户代理
      • 2 =表示应使用搜索引擎的用户代理
      • 3 =表示应使用基本浏览器的用户代理
  • templateId -添加一个 模板 指定DOCX文档的页眉和页脚的ID
    • 默认值:空
  • targetElement -id或class CSS选择器 目标网页上唯一要翻转的HTML元素 int在DOCX中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
    • 默认值:空
  • hideElement -id或class CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
    • 默认值:空
  • waitForElement -id或class CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
    • 默认值:空
  • quality - 返回的DOCX的质量。 DOCX中图像的默认质量为85%。
    • 降低质量会减少文件大小并减少下载时间。
    • 默认值:-1
    • 最低:-1
    • 最大:100
  • country - 国家 屏幕截图应取自。
    • 警告此功能目前处于测试阶段,可能无法提供一致的结果。
    • 默认值:当前最快的位置
    • 选项:“ SG”,“ UK”,“ US”
  • exportURL - 导出网址 指定捕获也应导出到的位置
    • 默认值:空
  • encryptionKey -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
    • 默认值:空
  • noAds - 如果属实 广告应自动隐藏.
    • 默认值:false
  • noCookieNotifications -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
    • 默认值:false
  • 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 -要转换的表的索引,即网页中的所有表从网页顶部到底部的顺序
    • 默认值:1
  • format -表格应采用的格式
    • 默认值:“ csv”
    • 选项:“ csv”,“ json”,“ xlsx”
  • includeHeaderNames -如果表中包含真实的标题名称
    • 默认值:true
  • includeAllTables -如果为true,则将提取网页上的所有表格,并且每个表格都显示在单独的电子表格中。 仅适用于XLSX格式
    • 默认值:false
  • targetElement -网页中唯一可用于从中提取表格的HTML元素的ID
    • 默认值:空
  • requestAs -您希望使用的用户代理类型
    • 默认值:0
    • 选项:
      • 0 =指示应使用标准浏览器的用户代理
      • 1 =指示应使用移动浏览器的用户代理
      • 2 =表示应使用搜索引擎的用户代理
      • 3 =表示应使用基本浏览器的用户代理
  • 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(saveToFile,未完成)

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控制,这将很有用。

参数

  • name-要设置的Cookie的名称
    • 其他要求
  • 域-要为其设置Cookie的网站的域
    • 其他要求
  • 选项
    • value-Cookie的值
    • path-Cookie所涉及的网站路径
    • httponly-如果为true,则cookie只能与HTTP协议一起使用
    • 过期-定义cookie的过期时间。 如果cookie不应该过期,则传递一个null值
    {
        'value':'me@example.com',
        'httponly':false
    }
    
  • oncomplete(错误,成功)-回调函数,在设置cookie时调用。 如果成功设置了cookie,则成功参数为true,否则为false

delete_cookie(名称,域,未完成)

删除自定义cookie或阻止全局cookie被使用

参数

  • name-要删除的Cookie的名称
    • 其他要求
  • 域-要删除其Cookie的网站的域
    • 其他要求
  • oncomplete(错误,成功)-回调函数,在设置cookie时调用。 如果删除cookie,则成功参数为true,否则为false。

get_watermarks()

获取所有上传的自定义水印

参数

  • 未完成(错误, 水印)-回调函数,当检索到水印时调用。 水印参数包含水印数组。
    • 其他要求

get_watermark(标识符,未完成)

返回与指定标识符匹配的自定义水印

参数

  • 标识符-您要查看的特定自定义水印的标识符
    • 其他要求
  • 未完成(错误, 水印)-回调函数,当检索到水印时调用。 水印参数包含水印数组。
    • 其他要求

add_watermark(标识符,路径,xpos,ypos,oncomplete)

添加新的自定义水印

参数

  • 标识符-您要提供自定义水印的标识符。 此标识符唯一是很重要的。
    • 其他要求
  • path-服务器上水印的绝对路径。 例如C:/watermark/1.png
    • 其他要求
  • xpos-您希望屏幕截图出现在的水平位置
    • 其他要求
    • 选项:
      • 左= 0
      • 中心= 1
      • 右= 2
  • ypos-您希望屏幕截图出现在的垂直位置
    • 其他要求
    • 选项:
      • 顶部= 0
      • 中= 1
      • 底部= 2
  • oncomplete(错误,成功)-回调函数,添加水印后调用。 如果成功添加了水印,则成功参数为true,否则为false。
    • 其他要求

delete_watermark(标识符,未完成)

删除自定义水印

参数

  • 标识符-您要删除的自定义水印的标识符
    • 其他要求
  • oncomplete(错误,成功)-回调函数,当去除水印后调用。 如果成功删除水印,则成功参数为true。
    • 其他要求

set_local_proxy(值)

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

参数

  • value-代理的URL,如果需要,可以包含端口。 提供空值将删除任何先前设置的代理
    • 其他要求

use_ssl(值)

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

参数

  • 值-如果为true,则对GrabzIt API的所有请求都将使用SSL
    • 其他要求

create_encryption_key()

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


解密(数据,密钥)

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

参数

  • path-加密捕获的路径
    • 其他要求
  • 关键- 加密金钥
    • 其他要求

crypto_file(路径,密钥,未完成)

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

参数

  • path-加密捕获的路径
    • 其他要求
  • 关键- 加密金钥
    • 其他要求
  • oncomplete(error)-回调函数,在解密文件时调用。

结果类

饼干

公共变量

  • 名称-Cookie名称
  • 值-Cookie值
  • 域-设置Cookie的域
  • path-此Cookie应用于的域上的路径。
  • httponly-如果此cookie仅在使用HTTP协议查看网站时有效。
  • 过期-此Cookie过期的日期
  • type-这是Cookie的类型
    • 选项:
      • 全局-这是GrabzIt设置的全局cookie
      • 本地-这是您设置的本地Cookie
      • 已覆盖-已被您覆盖的全局cookie

当前状态

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

公共变量

  • 处理-如果为true,则仍在处理屏幕截图。
  • 已缓存-如果为true,则屏幕快照已被处理并且当前已缓存。
  • 已过期-如果为true,则屏幕截图不再在GrabzIt系统上。
  • message-系统返回的错误消息。

WaterMark

此类表示存储在GrabzIt中的自定义水印

公共变量

  • 标识符-水印的标识符
  • format-水印图像的格式
  • xPosition-屏幕截图上水印出现的x位置
    • 选项:
      • 左= 0
      • 中心= 1
      • 右= 2
  • yPosition-屏幕截图上水印出现的y位置
    • 选项:
      • 顶部= 0
      • 中= 1
      • 底部= 2