产品描述
此类处理与GrabzIt屏幕快照Web服务的所有通信。
公开方法
- GrabzItFile GetResult(String id)
- URLToAnimation(String url, AnimationOptions options)
- URLToImage(String url, ImageOptions options)
- HTMLToImage(String html, ImageOptions options)
- FileToImage(String path, ImageOptions options)
- URLToPDF(String url, PDFOptions options)
- HTMLToPDF(String html, PDFOptions options)
- FileToPDF(String path, PDFOptions options)
- URLToDOCX(String url, DOCXOptions options)
- HTMLToDOCX(String html, DOCXOptions options)
- FileToDOCX(String path, DOCXOptions options)
- URLToTable(String url, TableOptions options)
- HTMLToTable(String html, TableOptions options)
- FileToTable(String path, TableOptions options)
- URLToRenderedHTML(String url, HTMLOptions options)
- HTMLToRenderedHTML(String html, HTMLOptions options)
- FileToRenderedHTML(String path, HTMLOptions options)
- String Save()
- String Save(String callBackURL)
- GrabzItFile SaveTo()
- boolean SaveTo(String saveToFile)
- Status GetStatus(String id)
- GrabzItCookie[] GetCookies(String domain)
- boolean SetCookie(String name, String domain, String value, String path, boolean httponly, Date? expires)
- boolean DeleteCookie(String name, String domain)
- WaterMark[] GetWaterMarks()
- WaterMark GetWaterMark(String identifier)
- boolean AddWaterMark(String identifier, String path, HorizontalPosition xpos, VerticalPosition ypos)
- boolean DeleteWaterMark(String identifier)
- SetLocalProxy(String proxyUrl)
- UseSSL(boolean value)
- String CreateEncryptionKey()
- Decrypt(String path, String key)
- GrabzItFile Decrypt(GrabzItFile file, String key)
- byte[] Decrypt(byte[] data, String key)
此方法返回屏幕快照本身。 如果未返回任何内容,则说明出现问题或屏幕截图尚未准备好。
参数
回报值
GrabzItFile 对象
指定应转换的在线视频的URL int动画GIF。
参数
-
url-要转换的在线视频的URL into动画GIF。
- 其他要求
-
接受Vimeo和YouTube视频URL
- 对Vimeo和YouTube视频进行动画制作的警告取决于第三方,因此可能无法提供一致的结果。
- 选项 -的实例 AnimationOptions 定义在创建动画GIF时要使用的任何特殊选项的类。
回报值
无效
AnimationOptions
该类表示创建动画GIF时所有可用的选项。
公共财产
-
setCustomId(String value) -您可以传递给动画GIF Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
setWidth(int value) -生成的动画GIF的宽度(以像素为单位)。
- 默认值:180px
- 最大:包装的最大宽度
- 自动调整大小:-1 (传递-1表示 动画GIF缩放 关于其高度,如果宽度是自动调整大小,则高度不能)
-
setHeight(int value) -生成的动画GIF的高度(以像素为单位)。
- 默认值:120px
- 最大:包装的最大高度
- 自动调整大小:-1 (传递-1表示 动画GIF缩放 关于宽度,如果要自动调整高度,则宽度不能)
-
setStart(int value) -应该转换的视频的起始位置 int动画GIF。
-
setDuration(int value) -应该转换的视频的长度(以秒为单位) int动画GIF。
-
setSpeed(float value) -动画GIF的速度。
-
setFramesPerSecond(float value) -每秒应从视频中捕获的帧数。
-
setRepeat(int value) -循环播放动画GIF的次数。
-
setReverse(boolean value) -如果为true,则动画GIF的帧反转
-
setCustomWaterMarkId(String value) -添加一个 习俗 watermark or 特别 watermark 到动画GIF
-
setQuality(int value) - 返回图像的质量,其默认压缩率为85%。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
setCountry(Country value) - 国家 动画GIF应该取自。
- 默认值:当前最快的位置
- 选项: 国家。新加坡, 国家。英国, 国家。美国
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
URLToImage(String 网址, ImageOptions 选项)
指定应转换的URL intoa图像截图。
参数
-
url-屏幕快照的URL
- 选项 -的实例 ImageOptions 类,定义在创建屏幕快照时要使用的任何特殊选项。
回报值
无效
HTMLToImage(String html, ImageOptions 选项)
指定应转换的HTML intoa图像。
参数
-
html- 要转换的HTML intoa图片
- 选项 -的实例 ImageOptions 定义创建图像时要使用的任何特殊选项的类。
回报值
无效
FileToImage(String 路径, ImageOptions 选项)
指定应转换的HTML文件 intoa图像。
参数
-
path-要转换的HTML文件的文件路径 intoa图片
- 选项 -的实例 ImageOptions 定义创建图像时要使用的任何特殊选项的类。
回报值
无效
ImageOptions
该类表示创建图像捕获时所有可用的选项。
公共财产
-
setCustomId(String value) -您可以传递给屏幕截图Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
setBrowserWidth(int value) -浏览器的宽度(以像素为单位)
-
setBrowserHeight(int value) -浏览器的高度(以像素为单位)
- 默认值:1170
- 最大:10000
- 全长:-1 (传递-1表示获取整个网页的截图)
-
setOutputWidth(int value) -结果缩略图的宽度(以像素为单位)
- 默认值:如果未同时指定输出宽度和输出高度或为0,则输出宽度和高度将与最终图像的宽度和高度相匹配;如果指定了输出高度,则输出宽度将与输出高度成比例
- 最大:包装的最大宽度
- 全宽:-1 (传递-1表示缩略图的宽度不会减小)
-
setOutputHeight(int value) -结果缩略图的高度(以像素为单位)
- 默认值:如果未同时指定输出宽度和输出高度或为0,则输出宽度和高度将与最终图像的宽度和高度相匹配;如果指定了输出宽度,则输出高度将与输出宽度成比例
- 最大:包装的最大高度
- 全高:-1 (传递-1表示缩略图的高度不会减小)
-
setFormat(ImageFormat value) -屏幕截图应采用的格式。
-
setDelay(int value) -的毫秒数 等待截图之前
-
setClickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
setTargetElement(String value) - CSS选择器 目标网页上唯一要翻转的HTML元素 int在屏幕截图中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
-
setHideElement(String value) - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
setWaitForElement(String value) - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
setRequestAs(BrowserType value) -您希望使用的用户代理类型
-
setCustomWaterMarkId(String value) -添加一个 习俗 watermark or 特别 watermark 对图像
-
setQuality(int value) - 返回图像的质量。 目前,这仅会影响JPG和WEBP图像,它们的默认压缩率为90%。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
setTransparent(boolean value) -如果为true 图像捕获应该是透明的。 这仅与png和tiff图像兼容。
-
setHd(boolean value) -如果图像真实 捕获将是高清 这会使图像尺寸增加一倍。
-
setCountry(Country value) - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项: 国家。新加坡, 国家。英国, 国家。美国
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setNoAds(boolean noAds) - 如果属实 广告应自动隐藏.
-
setNoCookieNotifications(boolean noCookieNotifications) -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
setAddress(String address) -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
公开方法
-
AddPostParameter(String 名称, String 值) -定义HTTP Post参数和可选值,可以多次调用此方法以添加多个参数。 使用此方法将强制GrabzIt 执行HTTP发布.
- name-HTTP Post参数的名称
- value-HTTP Post参数的值
URLToRenderedHTML(String 网址, HTMLOptions 选项)
指定应转换的URL into呈现HTML。
参数
-
url-呈现HTML的URL
-
选项 -的实例 HTMLOptions 类,定义创建呈现的HTML时要使用的任何特殊选项。
回报值
无效
HTMLToRenderedHTML(string html, HTMLOptions 选项)
指定应转换的HTML into呈现HTML。
参数
-
html- 要转换的HTML into呈现的HTML
- 选项 -的实例 HTMLOptions 定义创建渲染HTML时要使用的任何特殊选项的类。
回报值
无效
FileToRenderedHTML(string 路径, HTMLOptions 选项)
指定应转换的HTML文件 into呈现HTML。
参数
-
path-要转换的HTML文件的文件路径 into呈现的HTML
-
选项 -的实例 HTMLOptions 定义创建渲染HTML时要使用的任何特殊选项的类。
回报值
无效
HTMLOptions
该类表示在以下情况下所有可用的选项 创建渲染的HTML捕获.
公共财产
-
setCustomId(String value) -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
setBrowserWidth(int value) -浏览器的宽度(以像素为单位)
-
setBrowserHeight(int value) -浏览器的高度(以像素为单位)
-
setWaitForElement(String value) - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
setRequestAs(BrowserType value) -您希望使用的用户代理类型
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setNoAds(boolean noAds) - 如果属实 广告应自动隐藏.
-
setNoCookieNotifications(boolean noCookieNotifications) -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
setAddress(String address) -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
公开方法
-
AddPostParameter(String 名称, String 值) -定义HTTP Post参数和可选值,可以多次调用此方法以添加多个参数。 使用此方法将强制GrabzIt 执行HTTP发布.
- name-HTTP Post参数的名称
- value-HTTP Post参数的值
URLToPDF(String 网址, PDF选项 选项)
指定应转换的URL intoa PDF。
参数
-
url-应该转换的网址 int一份PDF
- PDF选项 options-PDFOptions类的实例,它定义在创建PDF时要使用的任何特殊选项。
回报值
无效
HTMLToPDF(String html, PDF选项 选项)
指定应转换的HTML intoa PDF。
参数
-
html- 要转换的HTML int一份PDF
- PDF选项 options-PDFOptions类的实例,它定义在创建PDF时要使用的任何特殊选项。
回报值
无效
FileToPDF(String 路径, PDF选项 选项)
指定应转换的HTML文件 intoa PDF。
参数
-
path-要转换的HTML文件的文件路径 int一份PDF
- PDF选项 options-PDFOptions类的实例,它定义在创建PDF时要使用的任何特殊选项。
回报值
无效
PDF选项
该类表示创建PDF捕获时所有可用的选项。
公共财产
-
setCustomId(String value) -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
setIncludeBackground(boolean value) -如果为true,则屏幕截图中应包含网页背景
-
setPageSize(PageSize value) -PDF的页面大小
-
setOrientation(PageOrientation value) -PDF文件的方向
-
setCSSMediaType(CSSMediaType value) - PDF文档的CSS媒体类型
-
setIncludeLinks(boolean value) -如果链接应包含在PDF中,则为true
-
setIncludeOutline(boolean value) -如果为真 PDF书签 应该包括在内
-
setTitle(String value) -提供PDF文档的标题
-
setCoverURL(string value) -应该用作PDF封面的网页的网址
-
setMarginTop(int value) -应出现在PDF文档页面顶部的以毫米为单位的边距
-
setMarginLeft(int value) -应在PDF文档页面左侧显示的以毫米为单位的边距
-
setMarginBottom(int value) -应在PDF文档页面底部显示的以毫米为单位的边距
-
setMarginRight(int value) -PDF文档右侧应出现的以毫米为单位的边距
-
setBrowserWidth(int value) -的 浏览器的宽度 以像素为单位
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
- 默认值:1366
- 最大:10000
- 自动宽度:-1 (传递-1表示浏览器的宽度与PDF文档的宽度匹配)
-
setPageWidth(int value) - 生成的PDF的自定义宽度 单位为毫米
-
setPageHeight(int value) - 生成的PDF的自定义高度 单位为毫米
-
setDelay(int value) -的毫秒数 等待截图之前
-
setRequestAs(BrowserType value) -您希望使用的用户代理类型
-
setTemplateId(String value) -添加一个 模板 指定PDF文档的页眉和页脚的ID
-
setClickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
setTargetElement(String value) - CSS选择器 唯一的 目标网页上将要打开的HTML元素 int一份PDF,网页的所有其他部分都将被忽略。 如果有多个匹配的HTML元素,则选择第一个
-
setHideElement(String value) - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
setWaitForElement(String value) - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
setCustomWaterMarkId(String value) -添加一个 习俗 watermark or 特别 watermark 到PDF文档的每一页
-
setQuality(int value) - 返回的PDF的质量。 默认使用PDF的推荐质量。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
setCountry(Country value) - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项: 国家。新加坡, 国家。英国, 国家。美国
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setNoAds(boolean noAds) - 如果属实 广告应自动隐藏.
-
setNoCookieNotifications(boolean noCookieNotifications) -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
setAddress(String address) -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
-
setMergeId(String mergeId) -捕获的ID,应为 在新的PDF文档的开头合并
-
setPassword(String password) - 保护PDF文档的密码 和
公开方法
-
AddPostParameter(String 名称, String 值) -定义HTTP Post参数和可选值,可以多次调用此方法以添加多个参数。 使用此方法将强制GrabzIt 执行HTTP发布.
- name-HTTP Post参数的名称
- value-HTTP Post参数的值
-
AddTemplateParameter(String 名称, String 值) -定义一个 自定义模板 参数和值,可以多次调用此方法以添加多个参数。
- name-模板参数的名称
- value-模板参数的值
URLToDOCX(String 网址, DOCXOptions 选项)
指定应转换的URL int或DOCX。
参数
-
url-应该转换的网址 intDOCX
- DOCXOptions options-的实例 DOCXOptions 类,定义创建DOCX时要使用的任何特殊选项。
回报值
无效
HTMLToDOCX(String html, DOCXOptions 选项)
指定应转换的HTML int或DOCX。
参数
回报值
无效
FileToDOCX(String 路径, DOCXOptions 选项)
指定应转换的HTML文件 int或DOCX。
参数
-
path-要转换的HTML文件的文件路径 intDOCX
- DOCXOptions options-的实例 DOCXOptions 类,定义创建DOCX时要使用的任何特殊选项。
回报值
无效
DOCXOptions
该类表示创建DOCX捕获时所有可用的选项。
公共财产
-
setCustomId(String value) -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回。
-
setIncludeBackground(boolean value) -如果为true,则网页的背景图片应包含在DOCX中
-
setPageSize(PageSize value) -DOCX的页面大小
-
setOrientation(PageOrientation value) -DOCX文档的方向
-
setIncludeLinks(boolean value) -如果链接应包含在DOCX中,则为true
-
setIncludeImages(boolean value) -如果为true,则网页图像应包含在DOCX中
-
setTitle(String value) -提供DOCX文档的标题
-
setMarginTop(int value) -应在DOCX文档页面顶部显示的以毫米为单位的边距
-
setMarginLeft(int value) -应在DOCX文档页面左侧显示的以毫米为单位的边距
-
setMarginBottom(int value) -应在DOCX文档页面底部显示的以毫米为单位的边距
-
setMarginRight(int value) -DOCX文档右侧应出现的以毫米为单位的边距
-
setBrowserWidth(int value) - 浏览器的宽度 以像素为单位
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
- 默认值:1366
- 最大:10000
- 自动宽度:-1 (传递-1表示浏览器的宽度与PDF文档的宽度匹配)
-
setPageWidth(int value) - 生成的DOCX的自定义宽度 单位为毫米
-
setPageHeight(int value) - 生成的DOCX的自定义高度 单位为毫米
-
setDelay(int value) -的毫秒数 等待截图之前
-
setRequestAs(BrowserType value) -您希望使用的用户代理类型
-
setTemplateId(String value) -添加一个 模板 指定DOCX文档的页眉和页脚的ID
-
setClickElement -使用来指定HTML元素 CSS选择器 点击。 请记住,查看点击效果可能也需要延迟
- 警告此功能目前处于测试阶段,可能无法提供一致的结果。
-
setTargetElement(String value) - CSS选择器 目标网页上唯一要翻转的HTML元素 int在屏幕截图中,将忽略网页的所有其他部分。 如果有多个匹配的HTML元素,则选择第一个
-
setHideElement(String value) - CSS选择器 网页中要隐藏的一个或多个HTML元素中的一个,以指定多个HTML元素来隐藏,以逗号分隔每个选择器
-
setWaitForElement(String value) - CSS选择器 网页中HTML元素的 在执行捕获之前必须可见
-
setQuality(int value) - 返回的DOCX的质量。 默认值为DOCX使用推荐的质量。
- 降低质量会减少文件大小并减少下载时间。
- 默认值:-1
- 最低:-1
- 最大:100
-
setCountry(Country value) - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项: 国家。新加坡, 国家。英国, 国家。美国
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setNoAds(boolean noAds) - 如果属实 广告应自动隐藏.
-
setNoCookieNotifications(boolean noCookieNotifications) -如果为true,则通常会找到所有 Cookie通知应自动隐藏.
-
setAddress(String address) -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
-
setMergeId(String mergeId) -捕获的ID,应为 在新的DOCX文档的开头合并
-
setPassword(String mergeId) - 保护DOCX文档的密码 和
公开方法
-
AddPostParameter(String 名称, String 值) -定义HTTP Post参数和可选值,可以多次调用此方法以添加多个参数。 使用此方法将强制GrabzIt 执行HTTP发布.
- name-HTTP Post参数的名称
- value-HTTP Post参数的值
-
AddTemplateParameter(String 名称, String 值) -定义一个 自定义模板 参数和值,可以多次调用此方法以添加多个参数。
- name-模板参数的名称
- value-模板参数的值
URLToTable(String 网址, TableOptions 选项)
指定应从中提取HTML表的URL。
参数
-
url-从中提取HTML表的URL
- TableOptions options-的实例 TableOptions 定义在转换HTML表时要使用的任何特殊选项的类。
回报值
无效
HTMLToTable(String html, TableOptions 选项)
指定应从中提取HTML表的HTML。
参数
-
html-从中提取HTML表的HTML。
- TableOptions options-的实例 TableOptions 定义在转换HTML表时要使用的任何特殊选项的类。
回报值
无效
FileToTable(String 路径, TableOptions 选项)
指定应从中提取HTML表的HTML文件。
参数
-
path-从中提取HTML表的HTML文件的文件路径。
- TableOptions options-的实例 TableOptions 定义在转换HTML表时要使用的任何特殊选项的类。
回报值
无效
TableOptions
该类表示将HTML表转换为CSV,XLSX或JSON时可用的所有选项。
公共财产
-
setCustomId(String value) -您可以传递给Web服务的自定义标识符。 这将与您指定的回调URL一起返回
-
setTableNumberToInclude(int value) -要转换的表的索引,即网页中的所有表从网页顶部到底部的顺序
-
setFormat(TableFormat value) -表格应采用的格式
-
setIncludeHeaderNames(boolean value) -如果表中包含真实的标题名称
-
setIncludeAllTables(boolean value) -如果为true,则将提取网页上的所有表格,并且每个表格都显示在单独的电子表格中。 仅适用于XLSX格式
-
setTargetElement(String value) -网页中唯一可用于从中提取表格的HTML元素的ID
-
setRequestAs(BrowserType value) -您希望使用的用户代理类型
-
setCountry(Country value) - 国家 屏幕截图应取自。
- 默认值:当前最快的位置
- 选项: 国家。新加坡, 国家。英国, 国家。美国
-
setExportURL(String value) - 导出网址 指定捕获也应导出到的位置
-
setEncryptionKey(String key) -如果指定了基本的64编码的AES加密密钥,则捕获将在创建时进行加密。 建议使用 创建加密密钥方法 创建密钥和 解密方法 如图所示解密加密的捕获 这个例子.
-
setAddress(String address) -在其中执行HTML代码的URL。如果要转换的HTML使用 CSS和图像等资源的相对URL.
-
setProxy(String proxy) - HTTP代理详细信息 浏览器软件应使用它来创建此捕获
公开方法
-
AddPostParameter(String 名称, String 值) -定义HTTP Post参数和可选值,可以多次调用此方法以添加多个参数。 使用此方法将强制GrabzIt 执行HTTP发布.
- name-HTTP Post参数的名称
- value-HTTP Post参数的值
Save()
Save 异步返回结果,并返回唯一的标识符,该标识符可用于获取带有 GetResult 方法。
回报值
屏幕截图的唯一标识符,否则,如果发生错误,则引发异常。 这可以用来获取带有 GetResult 方法
这是保存文件的推荐方法
Save(String callBackURL)
Save 异步返回结果,并返回唯一的标识符,该标识符可用于获取带有 GetResult 方法。
参数
-
callBackURL- 处理器 GrabzIt服务应在完成工作后致电
回报值
屏幕截图的唯一标识符,否则,如果发生错误,则引发异常。 这可以用来获取带有 GetResult 方法
警告此方法是同步的,因此在处理结果时将导致应用程序暂停
Save 结果同步到 GrabzItFile 目的。
回报值
GrabzItFile 对象
警告此方法是同步的,因此在处理结果时将导致应用程序暂停
SaveTo(String saveTo文件)
Save 结果同步到文件。
参数
-
saveToFile-捕获的文件路径 saved至完成后
回报值
如果成功,则返回true,否则将引发异常。
Status GetStatus(String ID)
获取GrabzIt屏幕快照的当前状态。
参数
回报值
Status 对象
获取所有GrabzIt用于特定域的cookie。 这也可能包括用户定义的cookie。
参数
回报值
GrabzItCookie 排列
SetCookie(String 名称, String 域, String 值, String 路径, boolean httponly,日期过期)
在GrabzIt上设置一个新的自定义cookie,如果该自定义cookie与全局cookie具有相同的名称和域,则将覆盖全局cookie。
如果网站功能由Cookie控制,这将很有用。
参数
-
name-要设置的Cookie的名称
-
域-要为其设置Cookie的网站的域
- value-Cookie的值
- path-Cookie所涉及的网站路径
- httponly-如果为true,则cookie只能与HTTP协议一起使用
- 过期-定义cookie的过期时间。 如果cookie不应该过期,则传递一个null值
回报值
如果成功设置了cookie,则为true,否则为false
DeleteCookie(String 名称, String 域)
删除自定义cookie或阻止全局cookie被使用
参数
-
name-要删除的Cookie的名称
-
域-要删除其Cookie的网站的域
回报值
如果成功删除了cookie,则为true,否则为false
获取所有上传的自定义 watermarks
回报值
WaterMark 排列
WaterMark 积极参与WaterMark(String 标识符)
返回您的习惯 watermarks 与指定的标识符匹配
参数
-
标识符-特定习惯的标识符 watermark 你想查看
回报值
WaterMark 对象
添加新的自定义 watermark
参数
-
标识符-您要赋予自定义的标识符 watermark。 此标识符是唯一的,这一点很重要。
-
path-的绝对路径 watermark 在您的服务器上。 例如C:/watermark/1.png
-
xpos-您希望屏幕截图出现在的水平位置
-
ypos-您希望屏幕截图出现在的垂直位置
回报值
如果返回true watermark 设置成功
DeleteWaterMark(String 标识符)
删除自定义 watermark
参数
-
标识符-海关的标识符 watermark 您要删除
回报值
如果返回true watermark 已成功删除
SetLocalProxy(String proxyUrl)
此方法启用 本地代理服务器 用于所有请求。
参数
-
proxyUrl-代理的URL,如果需要,可以包含端口。 提供空值将删除任何先前设置的代理
UseSSL(boolean 值)
指定是否向GrabzIt发出请求 API应该使用SSL
参数
-
值-如果为true,则对GrabzIt API的所有请求都将使用SSL
String CreateEncryptionKey()
创建一个加密安全的基本64加密密钥,长度为44个字符。
解密(String 路径, String 键)
使用提供的加密密钥对加密的捕获进行解密。
参数
GrabzItFile 解密(GrabzItFile 文件, String 键)
使用提供的加密密钥对加密的捕获进行解密。
参数
-
文件-加密的 GrabzItFile
-
关键- 加密金钥
byte []解密(byte []数据, String 键)
使用提供的加密密钥对加密的捕获进行解密。
参数
枚举
ImageFormat
该枚举包含以下值。
- BMP8
- BMP16
- BMP24
- 骨形态发生蛋白
- JPG格式
- TIFF格式
- PNG
- WEBP
BrowserType
该枚举包含以下值。
国家
该枚举包含以下值。
PageSize
该枚举包含以下值。
- A3
- A4
- A5
- A6
- B3
- B4
- B5
- B6
- 政策条款
- 函件
PageOrientation
该枚举包含以下值。
CSSMediaType
该枚举包含以下值。
TableFormat
该枚举包含以下值。
HorizontalPosition
该枚举包含以下值。
VerticalPosition
该枚举包含以下值。
结果类
Cookies
公共财产
-
String getName()
-
String getValue()
-
String getDomain()
-
String getPath()
-
String getHttpOnly()
- 如果此cookie仅在使用HTTP协议查看网站时有效。
-
String getExpires()
-
String getType()
-
这是cookie的类型,可以是以下之一:
- 全局-这是GrabzIt设置的全局cookie
- 本地-这是您设置的本地Cookie
- 已覆盖-已被您覆盖的全局cookie
GrabzItFile
公开方法
- byte [] getBytes()
- 无效 Save(String 路径)
- String 至String()
Status
表示屏幕快照当前状态的类。
公开方法
-
boolean isProcessing()
-
boolean isCached()
-
boolean isExpired()
- 如果为true,则屏幕截图不再在GrabzIt系统上。
-
String getMessage()
WaterMark
此类代表风俗习惯 watermarks 存储在GrabzIt中
公开方法