捕獲和轉換Web的工具

Perl客戶Perl API

產品描述

此類處理與GrabzIt屏幕快照Web服務的所有通信。

公開方法

GetResult($ id)

此方法返回屏幕快照本身。 如果未返回任何內容,則說明出現問題或屏幕截圖尚未準備好。

參數

  • id-屏幕截圖的唯一標識符
    • 需要的

回報值

捕獲


URLToAnimation($ url, $選項)

指定應轉換的在線視頻的URL int動畫GIF。

參數

  • url-要轉換的在線視頻的URL into動畫GIF。
    • 需要的
    • 接受Vimeo和YouTube視頻URL
      • 對Vimeo和YouTube視頻進行動畫製作的警告取決於第三方,因此可能無法提供一致的結果。
  • 選項 -GrabzIt的實例AnimationOptions 定義在創建動畫GIF時要使用的任何特殊選項的類。

回報值

無效

抓斗AnimationOptions

該類表示創建動畫GIF時所有可用的選項。

公共財產

  • customId($value) -您可以傳遞給動畫GIF Web服務的自定義標識符。 這將與您指定的回調URL一起返回。
    • 默認值:空
  • width($value) -生成的動畫GIF的寬度(以像素為單位)。
    • 默認值:180px
    • 最大:包裝的最大寬度
    • 自動調整大小:-1 (傳遞-1表示 動畫GIF縮放 關於其高度,如果寬度是自動調整大小,則高度不能)
  • height($value) -生成的動畫GIF的高度(以像素為單位)。
    • 默認值:120px
    • 最大:包裝的最大高度
    • 自動調整大小:-1 (傳遞-1表示 動畫GIF縮放 關於寬度,如果要自動調整高度,則寬度不能)
  • start($value) -應該轉換的視頻的起始位置 int動畫GIF。
    • 默認值:0秒
  • duration($value) -應該轉換的視頻的長度(以秒為單位) int動畫GIF。
    • 默認值:包裝的最大長度
  • speed($value) -動畫GIF的速度。
    • 默認值:1
    • 最低:0.2
    • 上限:10
  • framesPerSecond($value) -每秒應從視頻中捕獲的幀數。
    • 默認值:10
    • 最低:0.2
    • 上限:60
  • repeat($value) -循環播放動畫GIF的次數。
    • 默認值:0
    • 連續循環:0
  • reverse($value) -如果1動畫GIF的幀相反
    • 默認值:0
  • customWaterMarkId($value) -將自定義水印添加到動畫GIF中
    • 默認值:空
  • quality($value) - “ 返回圖像的質量,其默認壓縮率為85%。
    • 降低質量會減少文件大小並減少下載時間。
    • 默認值:-1
    • 最低:-1
    • 上限:100
  • country($value) - 這個國家 動畫GIF應該取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼的AES加密密鑰,則捕獲將在創建時進行加密。 由於Perl的本機加密功能較差,因此您需要 按照這些說明 解密加密的捕獲。
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空

URLToImage($ url, $選項)

指定應轉換的URL intoa圖像截圖。

參數

  • url-屏幕快照的URL
    • 需要的
  • 選項 -GrabzIt的實例ImageOptions 類,定義在創建屏幕快照時要使用的任何特殊選項。

回報值

無效

HTMLToImage($ html, $選項)

指定應轉換的HTML intoa圖像。

參數

  • html- 要轉換的HTML intoa圖片
    • 需要的
  • 選項 -GrabzIt的實例ImageOptions 定義創建圖像時要使用的任何特殊選項的類。

回報值

無效

FileToImage($ path, $選項)

指定應轉換的HTML文件 intoa圖像。

參數

  • path-要轉換的HTML文件的文件路徑 intoa圖片
    • 需要的
  • 選項 -GrabzIt的實例ImageOptions 定義創建圖像時要使用的任何特殊選項的類。

回報值

無效

抓斗ImageOptions

該類表示創建圖像捕獲時所有可用的選項。

公共財產

  • customId($value) -您可以傳遞給屏幕截圖Web服務的自定義標識符。 這將與您指定的回調URL一起返回。
    • 默認值:空
  • browserWidth($value) -瀏覽器的寬度(以像素為單位)
    • 默認值:1024
    • 上限:10000
  • browserHeight($value) -瀏覽器的高度(以像素為單位)
    • 默認值:768
    • 上限:10000
    • 全長:-1 (傳遞-1表示獲取整個網頁的截圖)
  • width($value) -結果縮略圖的寬度(以像素為單位)
    • 默認值:瀏覽器寬度的最高比例,可能適合用戶包的最大寬度
    • 最大:包裝的最大寬度
    • 全寬:-1 (傳遞-1表示縮略圖的寬度不會減小)
  • height($value) -結果縮略圖的高度(以像素為單位)
    • 默認值:瀏覽器高度的最大比例,該比例適合用戶包的最大高度
    • 最大:包裝的最大高度
    • 全高:-1 (傳遞-1表示縮略圖的高度不會減小)
  • format($value) -屏幕截圖應採用的格式。
    • 默認值:“ jpg”
    • 選項:“ bmp8”,“ bmp16”,“ bmp24”,“ bmp”,“ tiff”,“ webp”,“ jpg”,“ png”
  • delay($value) -的毫秒數 等待截圖之前
    • 默認值:0
    • 上限:30000
  • targetElement($value) -id或class CSS選擇器 目標網頁上唯一要翻轉的HTML元素 int在屏幕截圖中,將忽略網頁的所有其他部分。 如果有多個匹配的HTML元素,則選擇第一個
    • 默認值:空
  • hideElement($value) -id或class CSS選擇器 網頁中要隱藏的一個或多個HTML元素中的一個,以指定多個HTML元素來隱藏,以逗號分隔每個選擇器
    • 默認值:空
  • waitForElement($value) -id或class CSS選擇器 網頁中HTML元素的 在執行捕獲之前必須可見
    • 默認值:空
  • requestAs($value) -您希望使用的用戶代理類型
    • 默認值:0
    • 選項:
      • 0 =指示應使用標準瀏覽器的用戶代理
      • 1 =指示應使用移動瀏覽器的用戶代理
      • 2 =表示應使用搜索引擎的用戶代理
      • 3 =表示應使用基本瀏覽器的用戶代理
  • customWaterMarkId($value) -向圖像添加自定義水印
    • 默認值:空
  • quality($value) - “ 返回圖像的質量。 目前,這僅會影響JPG圖像,其默認壓縮率為85%。
    • 降低質量會減少文件大小並減少下載時間。
    • 默認值:-1
    • 最低:-1
    • 上限:100
  • transparent($value) -如果1 圖像捕獲應該是透明的。 這僅與png和tiff圖像兼容。
    • 默認值:0
  • hd($value) -如果1圖片 捕獲將是高清 這會使圖像尺寸增加一倍。
    • 默認值:0
  • country($value) - 這個國家 屏幕截圖應取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼的AES加密密鑰,則捕獲將在創建時進行加密。 由於Perl的本機加密功能較差,因此您需要 按照這些說明 解密加密的捕獲。
    • 默認值:空
  • noAds($value) - 如果屬實 廣告應自動隱藏.
    • 默認值:false
  • noCookieNotifications($value) -如果為true,則通常會找到所有 Cookie通知應自動隱藏.
    • 默認值:false
  • address($value) -用於執行HTML代碼的URL。如果要轉換的HTML使用相對於CSS和圖像等資源的相對URL,則很有用。
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空

公開方法

  • AddPostParameter($ name,$ value) -定義HTTP Post參數和可選值,可以多次調用此方法以添加多個參數。 使用此方法將強制GrabzIt 執行HTTP發布.
    • name-HTTP Post參數的名稱
    • value-HTTP Post參數的值

URLToRenderedHTML($ url, $選項 = null)

指定應轉換的URL into呈現HTML。

參數

  • url-呈現HTML的URL
    • 需要的
  • 選項 -GrabzIt的實例HTMLOptions 類,定義創建呈現的HTML時要使用的任何特殊選項。

回報值

無效

HTMLToRenderedHTML($ html, $選項 = null)

指定應轉換的HTML into呈現HTML。

參數

  • html- 要轉換的HTML into呈現的HTML
    • 需要的
  • 選項 -GrabzIt的實例HTMLOptions 定義創建渲染HTML時要使用的任何特殊選項的類。

回報值

無效

FileToRenderedHTML($ path, $選項 = null)

指定應轉換的HTML文件 into呈現HTML。

參數

  • path-要轉換的HTML文件的文件路徑 into呈現的HTML
    • 需要的
  • 選項 -GrabzIt的實例HTMLOptions 定義創建渲染HTML時要使用的任何特殊選項的類。

回報值

無效

抓斗HTMLOptions

該類表示在以下情況下所有可用的選項 創建渲染的HTML捕獲.

公共財產

  • customId($value) -您可以傳遞給Web服務的自定義標識符。 這將與您指定的回調URL一起返回。
    • 默認值:空
  • browserWidth($value) -瀏覽器的寬度(以像素為單位)
    • 默認值:1024
    • 上限:10000
  • browserHeight($value) -瀏覽器的高度(以像素為單位)
    • 默認值:768
    • 上限:10000
  • delay($value) -的毫秒數 等待拍攝之前
    • 默認值:0
    • 上限:30000
  • waitForElement($value) -id或class CSS選擇器 網頁中HTML元素的 在執行捕獲之前必須可見
    • 默認值:空
  • requestAs($value) -您希望使用的用戶代理類型
    • 默認值:0
    • 選項:
      • 0 =指示應使用標準瀏覽器的用戶代理
      • 1 =指示應使用移動瀏覽器的用戶代理
      • 2 =表示應使用搜索引擎的用戶代理
      • 3 =表示應使用基本瀏覽器的用戶代理
  • country($value) - 這個國家 屏幕截圖應取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼AES加密密鑰,則您的捕獲在創建時將被加密。 建議使用 創建加密密鑰方法 創建密鑰和 解密方法 如圖所示解密加密的捕獲 這個例子.
    • 默認值:空
  • noAds($value) - 如果屬實 廣告應自動隱藏.
    • 默認值:false
  • noCookieNotifications($value) -如果為true,則通常會找到所有 Cookie通知應自動隱藏.
    • 默認值:false
  • address($value) -在其中執行HTML代碼的URL。如果要轉換的HTML使用 CSS和圖像等資源的相對URL.
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空

公開方法

  • AddPostParameter($ name,$ value) -定義HTTP Post參數和可選值,可以多次調用此方法以添加多個參數。 使用此方法將強制GrabzIt 執行HTTP發布.
    • name-HTTP Post參數的名稱
    • value-HTTP Post參數的值

URLToPDF($ url, $選項)

指定應轉換的URL intoa PDF。

參數

  • url-應該轉換的網址 int一份PDF
    • 需要的
  • 選項 -GrabzItPDFOptions類的實例,該類定義創建PDF時要使用的任何特殊選項。

回報值

無效

HTMLToPDF($ html, $選項)

指定應轉換的HTML intoa PDF。

參數

  • html- 要轉換的HTML int一份PDF
    • 需要的
  • 選項 -GrabzItPDFOptions類的實例,該類定義創建PDF時要使用的任何特殊選項。

回報值

無效

FileToPDF($ path, $選項)

指定應轉換的HTML文件 intoa PDF。

參數

  • path-要轉換的HTML文件的文件路徑 int一份PDF
    • 需要的
  • 選項 -GrabzItPDFOptions類的實例,該類定義創建PDF時要使用的任何特殊選項。

回報值

無效

GrabzItPDFOptions

該類表示創建PDF捕獲時所有可用的選項。

公共財產

  • customId($value) -您可以傳遞給Web服務的自定義標識符。 這將與您指定的回調URL一起返回。
    • 默認值:空
  • includeBackground($value) -如果是1,則網頁背景應包含在PDF中
    • 默認值:1
  • pagesize($value) -PDF的頁面大小
    • 默認值:“ A4”
    • 選項:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
  • orientation($value) -PDF文件的方向
    • 默認值:“肖像”
    • 選項:“縱向”,“橫向”
  • cssMediaType($value) - “ PDF文檔的CSS媒體類型
    • 默認值:“屏幕”
    • 選項:“屏幕”,“ Print"
  • includeLinks($value) -1,如果PDF中應包含鏈接
    • 默認值:1
  • includeOutline($value) -1,如果 PDF書籤 應該包括在內
    • 默認值:0
  • title($value) -提供PDF文檔的標題
    • 默認值:空
  • coverURL($value) -應該用作PDF封面的網頁的網址
    • 默認值:空
  • marginTop($value) -應該出現在PDF文檔頁面頂部的以毫米為單位的邊距
    • 默認值:10
  • marginLeft($value) -應在PDF文檔頁面左側顯示的以毫米為單位的邊距
    • 默認值:10
  • marginBottom($value) -應該出現在PDF文檔頁面底部的以毫米為單位的邊距
    • 默認值:10
  • marginRight($value) -PDF文檔右側應出現的以毫米為單位的邊距
    • 默認值:10
  • browserWidth($value) - “ 瀏覽器的寬度 以像素為單位
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:1024
    • 上限:10000
    • 自動寬度:-1 (傳遞-1表示瀏覽器的寬度與PDF文檔的寬度匹配)
  • pageWidth - “ 生成的PDF的自定義寬度 單位為毫米
  • pageHeight - “ 生成的PDF的自定義高度 單位為毫米
  • delay($value) -的毫秒數 等待截圖之前
    • 默認值:0
    • 上限:30000
  • requestAs($value) -您希望使用的用戶代理類型
    • 默認值:0
    • 選項:
      • 0 =指示應使用標準瀏覽器的用戶代理
      • 1 =指示應使用移動瀏覽器的用戶代理
      • 2 =表示應使用搜索引擎的用戶代理
      • 3 =表示應使用基本瀏覽器的用戶代理
  • templateId($value) -添加一個 模板 指定PDF文檔的頁眉和頁腳的ID
    • 默認值:空
  • targetElement($value) -id或class CSS選擇器 唯一的 目標網頁上將要打開的HTML元素 int一份PDF,網頁的所有其他部分都將被忽略。 如果有多個匹配的HTML元素,則選擇第一個
    • 默認值:空
  • hideElement($value) -id或class CSS選擇器 網頁中要隱藏的一個或多個HTML元素中的一個,以指定多個HTML元素來隱藏,以逗號分隔每個選擇器
    • 默認值:空
  • waitForElement($value) -id或class CSS選擇器 網頁中HTML元素的 在執行捕獲之前必須可見
    • 默認值:空
  • customWaterMarkId($value) -在PDF文檔的每一頁上添加自定義水印
    • 默認值:空
  • quality($value) - “ 返回的PDF的質量。 默認使用PDF的推薦質量。
    • 降低質量會減少文件大小並減少下載時間。
    • 默認值:-1
    • 最低:-1
    • 上限:100
  • country($value) - 這個國家 屏幕截圖應取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼的AES加密密鑰,則捕獲將在創建時進行加密。 由於Perl的本機加密功能較差,因此您需要 按照這些說明 解密加密的捕獲。
    • 默認值:空
  • noAds($value) - 如果屬實 廣告應自動隱藏.
    • 默認值:false
  • noCookieNotifications($value) -如果為true,則通常會找到所有 Cookie通知應自動隱藏.
    • 默認值:false
  • address($value) -用於執行HTML代碼的URL。如果要轉換的HTML使用相對於CSS和圖像等資源的相對URL,則很有用。
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空
  • mergeId($value) -捕獲的ID,應為 在新的PDF文檔的開頭合併
    • 默認值:空
  • password($value) - “ 保護PDF文檔的密碼
    • 默認值:空

公開方法

  • AddPostParameter($ name,$ value) -定義HTTP Post參數和可選值,可以多次調用此方法以添加多個參數。 使用此方法將強制GrabzIt 執行HTTP發布.
    • name-HTTP Post參數的名稱
    • value-HTTP Post參數的值
  • AddTemplateParameter($ name,$ value) -定義一個 自定義模板 參數和值,可以多次調用此方法以添加多個參數。
    • name-模板參數的名稱
    • value-模板參數的值

URLToDOCX($ url, $選項)

指定應轉換的URL int或DOCX。

參數

  • url-應該轉換的網址 intDOCX
    • 需要的
  • 選項 -GrabzIt的實例DOCXOptions 類,定義創建DOCX時要使用的任何特殊選項。

回報值

無效

HTMLToDOCX($ html, $選項)

指定應轉換的HTML int或DOCX。

參數

  • html- 要轉換的HTML intDOCX
    • 需要的
  • 選項 -GrabzIt的實例DOCXOptions 類,定義創建DOCX時要使用的任何特殊選項。

回報值

無效

FileToDOCX($ path, $選項)

指定應轉換的HTML文件 int或DOCX。

參數

  • path-要轉換的HTML文件的文件路徑 intDOCX
    • 需要的
  • 選項 -GrabzIt的實例DOCXOptions 類,定義創建DOCX時要使用的任何特殊選項。

回報值

無效

抓斗DOCXOptions

該類表示創建DOCX捕獲時所有可用的選項。

公共財產

  • customId($value) -您可以傳遞給Web服務的自定義標識符。 這將與您指定的回調URL一起返回。
    • 默認值:空
  • setIncludeBackground($value) -如果是1,則屏幕截圖中應包含網頁的背景圖片
    • 默認值:1
  • pagesize($value) -DOCX的頁面大小
    • 默認值:“ A4”
    • 選項:“ A3”,“ A4”,“ A5”,“ A6”,“ B3”,“ B4”,“ B5”,“ B6”,“法律”,“字母”
  • orientation($value) -DOCX文檔的方向
    • 默認值:“肖像”
    • 選項:“縱向”,“橫向”
  • includeLinks($value) -1,如果鏈接應包含在DOCX中
    • 默認值:1
  • includeImages($value) -如果是1,則屏幕截圖中應包含網頁的背景圖片
    • 默認值:1
  • title($value) -提供DOCX文檔的標題
    • 默認值:空
  • marginTop($value) -應在DOCX文檔頁面頂部顯示的以毫米為單位的邊距
    • 默認值:10
  • marginLeft($value) -應在DOCX文檔頁面左側顯示的以毫米為單位的邊距
    • 默認值:10
  • marginBottom($value) -應在DOCX文檔頁面底部顯示的以毫米為單位的邊距
    • 默認值:10
  • marginRight($value) -DOCX文檔右側應出現的以毫米為單位的邊距
    • 默認值:10
  • browserWidth($value) - “ 瀏覽器的寬度 以像素為單位
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:1024
    • 上限:10000
    • 自動寬度:-1 (傳遞-1表示瀏覽器的寬度與DOCX文檔的寬度匹配)
  • pageWidth - “ 生成的DOCX的自定義寬度 單位為毫米
  • pageHeight - “ 生成的DOCX的自定義高度 單位為毫米
  • delay($value) -的毫秒數 等待截圖之前
    • 默認值:0
    • 上限:30000
  • requestAs($value) -您希望使用的用戶代理類型
    • 默認值:0
    • 選項:
      • 0 =指示應使用標準瀏覽器的用戶代理
      • 1 =指示應使用移動瀏覽器的用戶代理
      • 2 =表示應使用搜索引擎的用戶代理
      • 3 =表示應使用基本瀏覽器的用戶代理
  • templateId($value) -添加一個 模板 指定DOCX文檔的頁眉和頁腳的ID
    • 默認值:空
  • targetElement($value) -id或class CSS選擇器 目標網頁上唯一要翻轉的HTML元素 int在DOCX中,將忽略網頁的所有其他部分。 如果有多個匹配的HTML元素,則選擇第一個
    • 默認值:空
  • hideElement($value) -id或class CSS選擇器 網頁中要隱藏的一個或多個HTML元素中的一個,以指定多個HTML元素來隱藏,以逗號分隔每個選擇器
    • 默認值:空
  • waitForElement($value) -id或class CSS選擇器 網頁中HTML元素的 在執行捕獲之前必須可見
    • 默認值:空
  • quality($value) - “ 返回的DOCX的質量。 默認值對DOCX使用推薦的質量。
    • 降低質量會減少文件大小並減少下載時間。
    • 默認值:-1
    • 最低:-1
    • 上限:100
  • country($value) - 這個國家 屏幕截圖應取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼的AES加密密鑰,則捕獲將在創建時進行加密。 由於Perl的本機加密功能較差,因此您需要 按照這些說明 解密加密的捕獲。
    • 默認值:空
  • noAds($value) - 如果屬實 廣告應自動隱藏.
    • 默認值:false
  • noCookieNotifications($value) -如果為true,則通常會找到所有 Cookie通知應自動隱藏.
    • 默認值:false
  • address($value) -用於執行HTML代碼的URL。如果要轉換的HTML使用相對於CSS和圖像等資源的相對URL,則很有用。
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空
  • mergeId($value) -捕獲的ID,應為 在新的DOCX文檔的開頭合併
    • 默認值:空
  • password($value) - “ 保護DOCX文檔的密碼
    • 默認值:空

公開方法

  • AddPostParameter($ name,$ value) -定義HTTP Post參數和可選值,可以多次調用此方法以添加多個參數。 使用此方法將強制GrabzIt 執行HTTP發布.
    • name-HTTP Post參數的名稱
    • value-HTTP Post參數的值
  • AddTemplateParameter($ name,$ value) -定義一個 自定義模板 參數和值,可以多次調用此方法以添加多個參數。
    • name-模板參數的名稱
    • value-模板參數的值

URLToTable($ url, $選項)

指定應從中提取HTML表的URL。

參數

  • url-從中提取HTML表的URL
    • 需要的
  • 選項 -GrabzIt的實例TableOptions 定義在轉換HTML表時要使用的任何特殊選項的類。

回報值

無效

HTMLToTable($ html, $選項)

指定應從中提取HTML表的HTML。

參數

  • html-從中提取HTML表的HTML。
    • 需要的
  • 選項 -GrabzIt的實例TableOptions 定義在轉換HTML表時要使用的任何特殊選項的類。

回報值

無效

FileToTable($ path, $選項)

指定應從中提取HTML表的HTML文件。

參數

  • path-從中提取HTML表的HTML文件的文件路徑。
    • 需要的
  • 選項 -GrabzIt的實例TableOptions 定義在轉換HTML表時要使用的任何特殊選項的類。

回報值

無效

抓斗TableOptions

該類表示將HTML表轉換為CSV,XLSX或JSON時可用的所有選項。

公共財產

  • customId($value) -您可以傳遞給Web服務的自定義標識符。 這將與您指定的回調URL一起返回
    • 默認值:空
  • tableNumberToInclude($value) -要轉換的表的索引,即網頁中的所有表從網頁頂部到底部的順序
    • 默認值:1
  • format($value) -表格應採用的格式
    • 默認值:“ csv”
    • 選項:“ csv”,“ json”,“ xlsx”
  • includeHeaderNames($value) -如果表中將包含1標頭名稱
    • 默認值:1
  • includeAllTables($value) -如果將1提取網頁上的所有表格,並且每個表格都顯示在單獨的電子表格中。 僅適用於XLSX格式
    • 默認值:0
  • targetElement($value) -網頁中唯一可用於從中提取表格的HTML元素的ID
    • 默認值:空
  • requestAs($value) -您希望使用的用戶代理類型
    • 默認值:0
    • 選項:
      • 0 =指示應使用標準瀏覽器的用戶代理
      • 1 =指示應使用移動瀏覽器的用戶代理
      • 2 =表示應使用搜索引擎的用戶代理
      • 3 =表示應使用基本瀏覽器的用戶代理
  • country($value) - 這個國家 屏幕截圖應取自。
    • 警告此功能目前處於測試階段,可能無法提供一致的結果。
    • 默認值:當前最快的位置
    • 選項:“ SG”,“ UK”,“ US”
  • exportURL($value) - “ 導出網址 指定捕獲也應導出到的位置
    • 默認值:空
  • encryptionKey($value) -如果指定了基本的64編碼的AES加密密鑰,則捕獲將在創建時進行加密。 由於Perl的本機加密功能較差,因此您需要 按照這些說明 解密加密的捕獲。
    • 默認值:空
  • address($value) -用於執行HTML代碼的URL。如果要轉換的HTML使用相對於CSS和圖像等資源的相對URL,則很有用。
    • 默認值:空
  • proxy($value) - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
    • 默認值:空

公開方法

  • AddPostParameter($ name,$ value) -定義HTTP Post參數和可選值,可以多次調用此方法以添加多個參數。 使用此方法將強制GrabzIt 執行HTTP發布.
    • name-HTTP Post參數的名稱
    • value-HTTP Post參數的值

這是保存文件的推薦方法

Save($ callBackURL ='')

Save 異步返回結果,並返回唯一的標識符,該標識符可用於獲取帶有 GetResult 方法。

參數

  • callBackURL- 處理器 GrabzIt服務應在完成工作後致電

回報值

屏幕截圖的唯一標識符,否則,如果發生錯誤,則引發異常。 這可以用來獲取帶有 GetResult 方法


警告此方法是同步的,因此在處理結果時將導致應用程序暫停

SaveTo()

Save 結果與包含屏幕快照字節數據的變量同步。

回報值

如果成功,則返回文件的字節數據,否則將引發異常。


警告此方法是同步的,因此在處理結果時將導致應用程序暫停

SaveTo($saveToFile)

Save 結果同步到文件。

參數

  • saveToFile-捕獲的文件路徑為 saved至完成後
    • 需要的

回報值

如果成功,則返回1,否則將引發異常。


GetStatus($ id)

獲取GrabzIt屏幕快照的當前狀態。

參數

  • id-屏幕截圖的唯一標識符
    • 需要的

回報值

GrabzItStatus 對象


GetCookies($ domain)

獲取所有GrabzIt用於特定域的cookie。 這也可能包括用戶定義的cookie。

參數

  • 域-要為其返回Cookie的域
    • 需要的

回報值

GrabzItCookie 排列


SetCookie($ name,$ domain,$ value ='',$ path ='/',$ httponly = 0,$ expires ='')

在GrabzIt上設置一個新的自定義cookie,如果該自定義cookie與全局cookie具有相同的名稱和域,則將覆蓋全局cookie。

如果網站功能由Cookie控制,這將很有用。

參數

  • name-要設置的Cookie的名稱
    • 需要的
  • 域-要為其設置Cookie的網站的域
    • 需要的
  • value-Cookie的值
  • path-Cookie所涉及的網站路徑
  • httponly-如果是1,則該cookie只能與HTTP協議一起使用
  • 過期-定義cookie的過期時間。 如果cookie不應該過期,則傳遞一個null值
    • 格式應為yyyy-mm-dd hh:mm:ss

回報值

如果成功設置了cookie,則為1,否則為0


DeleteCookie($ name,$ domain)

刪除自定義cookie或阻止全局cookie被使用

參數

  • name-要刪除的Cookie的名稱
    • 需要的
  • 域-要刪除其Cookie的網站的域
    • 需要的

回報值

如果成功刪除了Cookie,則為1,否則為0


獲得WaterMarks()

獲取上傳的自定義水印

回報值

抓斗WaterMark 排列


獲得WaterMark($ identifier)

返回與指定標識符匹配的自定義水印

參數

  • 標識符-您要查看的特定自定義水印的標識符
    • 需要的

回報值

抓斗WaterMark


添加WaterMark($ identifier,$ path,$ xpos,$ ypos)

添加新的自定義水印

參數

  • 標識符-您要提供自定義水印的標識符。 此標識符是唯一的,這一點很重要。
    • 需要的
  • path-服務器上水印的絕對路徑。 例如C:/watermark/1.png
    • 需要的
  • xpos-您希望屏幕截圖出現在的水平位置
    • 需要的
    • 選項:
      • 左= 0
      • 中心= 1
      • 右= 2
  • ypos-您希望屏幕截圖出現在的垂直位置
    • 需要的
    • 選項:
      • 頂部= 0
      • 中= 1
      • 底部= 2

回報值

如果成功設置水印,則返回1


DeleteWaterMark($ identifier)

刪除自定義水印

參數

  • 標識符-您要刪除的自定義水印的標識符
    • 需要的

回報值

如果成功刪除水印,則返回1


UseSSL($ value)

指定是否向GrabzIt發出請求 API應該使用SSL 或不

參數

  • 值-如果1對GrabzIt API的所有請求都將使用SSL
    • 需要的

結果類

GrabzItCookie

公開方法

  • getName()
    • Cookie名稱。
  • getValue()
    • Cookie值。
  • getDomain()
    • Cookie的設置域。
  • getPath()
    • 該cookie適用於域上的路徑。
  • getHttpOnly()
    • 如果此cookie僅在使用HTTP協議查看網站時有效。
  • getExpires()
    • 該Cookie過期的日期
  • getType()
    • 這是cookie的類型,可以是以下之一:
      • 全局-這是GrabzIt設置的全局cookie
      • 本地-這是您設置的本地Cookie
      • 已覆蓋-已被您覆蓋的全局cookie

GrabzItStatus

表示屏幕快照當前狀態的類。

公開方法

  • getProcessing()
    • 如果是1,則屏幕截圖仍在處理中。
  • getCached()
    • 如果是1,則截圖已被處理並且當前已被緩存。
  • getExpired()
    • 如果是1,則屏幕截圖不再位於GrabzIt系統上。
  • getMessage()
    • 系統返回的錯誤消息。

抓斗WaterMark

此類表示存儲在GrabzIt中的自定義水印

公開方法

  • getIdentifier()
    • 水印的標識符
  • getXPosition()
    • 水印的水平位置
      • 左= 0
      • 中心= 1
      • 右= 2
  • getYPosition()
    • 水印的垂直位置
      • 頂部= 0
      • 中= 1
      • 底部= 2
  • getFormat()
    • 水印的格式