Ruby ile GrabzIt Müşteri

Tanım

Bu sınıf, GrabzIt ekran görüntüsü web hizmetleri ile tüm iletişimi gerçekleştirir.

Genel Yöntemler

get_result(id)
url_to_animation(url, options = nil)
url_to_image(url, options = nil)
html_to_image(html, options = nil)
file_to_image(path, options = nil)
url_to_pdf(url, options = nil)
html_to_pdf(html, options = nil)
file_to_pdf(path, options = nil)
url_to_docx(url, options = nil)
html_to_docx(html, options = nil)
file_to_docx(path, options = nil)
url_to_table(url, options = nil)
html_to_table(html, options = nil)
file_to_table(path, options = nil)
url_to_rendered_html(url, options = nil)
html_to_rendered_html(html, options = nil)
file_to_rendered_html(path, options = nil)
save(callBackURL = nil)
save_to()
save_to(saveToFile)
get_status(id)
get_cookies(domain)
set_cookie(name, domain, value = "", path = "/", httponly = false, expires = "")
delete_cookie(name, domain)
get_watermarks()
get_watermark(identifier)
add_watermark(identifier, path, xpos, ypos)
delete_watermark(identifier)
set_local_proxy(value)
use_ssl(value)
create_encryption_key()
decrypt(path, key)
decrypt_file(path, key)

get_result (id)

Bu yöntem ekran görüntüsünün kendisini döndürür. Hiçbir şey döndürülmezse, bir şeyler ters gitti veya ekran görüntüsü henüz hazır değil.

parametreler

id - ekran görüntüsünün benzersiz tanımlayıcısı
- gereklidir

Geri dönüş değeri

Yakalamak

url_to_animation(Url seçenekleri = sıfır)

Dönüştürülmesi gereken çevrimiçi videonun URL’sini belirtin into bir animasyonlu GIF.

parametreler

url - dönüştürülecek çevrimiçi videonun URL’si into bir animasyonlu GIF.
- gereklidir
- Vimeo ve YouTube video URL’lerini kabul eder
  - Canlandırma uyarısı Vimeo ve YouTube videoları üçüncü taraflara bağlıdır ve bu nedenle tutarlı sonuçlar vermeyebilir.
seçenekleri - bir örneği AnimationOptions Hareketli GIF'i oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

AnimationOptions

Sınıf, animasyonlu bir GIF oluştururken mevcut seçeneklerin tümünü temsil eder.

Genel Mülkler

customId - Animasyonlu GIF web servisine aktarabileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
width - sonuçtaki animasyonlu GIF'in piksel cinsinden genişliği.
- Varsayılan: 180px
- Maksimum: Paket için maksimum genişlik
- Otomatik boyut: -1 (-1’in geçilmesi, animasyonlu GIF ölçeklendirilir yüksekliği ile ilgili olarak, genişlik otomatik olarak boyutlandırılıyorsa, yükseklik
height - sonuçtaki animasyonlu GIF'in piksel cinsinden yüksekliği.
- Varsayılan: 120px
- Maksimum: Paket için maksimum yükseklik
- Otomatik boyut: -1 (-1’in geçilmesi, animasyonlu GIF ölçeklendirilir genişliğine göre, yükseklik otomatik olarak boyutlandırılıyorsa genişlik
start - dönüştürülmesi gereken videonun başlangıç konumu into bir animasyonlu GIF.
- Varsayılan: 0 saniye
duration - dönüştürülmesi gereken videonun saniye cinsinden uzunluğu into bir animasyonlu GIF.
- Varsayılan: paket için maksimum uzunluk
speed - animasyonlu GIF'in hızı.
- Varsayılan: 1
- Minimum: 0.2
- Maksimum: 10
framesPerSecond - Videodan yakalanması gereken saniye başına kare sayısı.
- Varsayılan: 10
- Minimum: 0.2
- Maksimum: 60
repeat - animasyonlu GIF'i döngülemek için kaç kez?
- Varsayılan: 0
- Sürekli Döngü: 0
- Asla Döngü: -1
reverse - true ise, animasyonlu GIF’in kareleri ters çevrilir
- Varsayılan: yanlış
customWaterMarkId - ekle görenek watermark or özel watermark animasyonlu GIF'e
- Varsayılan: boş
quality - döndürülen görüntünün kalitesi, varsayılan olarak 85% sıkıştırmasına sahip.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke animasyonlu GIF alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

url_to_image(Url seçenekleri = sıfır)

Dönüştürülmesi gereken URL’yi belirtir into bir resim ekran görüntüsü.

parametreler

url - ekran görüntüsünün yapılması gereken URL
- gereklidir
seçenekleri - bir örneği ImageOptions Ekran görüntüsünü oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

html_to_image(HTML, seçenekleri = sıfır)

Dönüştürülmesi gereken HTML'yi belirtir into bir görüntü.

parametreler

html - dönüştürülecek HTML into bir görüntü
- gereklidir
seçenekleri - bir örneği ImageOptions Resim oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

file_to_image(yol, yörünge, seçenekleri = sıfır)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir görüntü.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir görüntü
- gereklidir
seçenekleri - bir örneği ImageOptions Resim oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

ImageOptions

Sınıf, görüntü yakalama oluşturulurken kullanılabilecek tüm seçenekleri temsil eder.

Genel Mülkler

customId - Ekran görüntüsü web servisine geçebileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
browserWidth - tarayıcının piksel cinsinden genişliği
- Varsayılan: 1366
- Maksimum: 10000
browserHeight - tarayıcının piksel cinsinden yüksekliği
- Varsayılan: 1170
- Maksimum: 10000
- Tam Boy: -1 (-1'i geçmek, tüm web sayfasının bir kısmının alındığı anlamına gelir)
width - sonuçtaki küçük resmin piksel cinsinden genişliği
- Varsayılan: hem çıktı genişliği hem de çıktı yüksekliği belirtilmezse veya 0 ise çıktı genişliği ve yüksekliği son görüntü genişliği ve yüksekliğiyle eşleşir, çıktı yüksekliği belirtilirse çıktı genişliği çıktı yüksekliğiyle orantılı olur
- Maksimum: Paket için maksimum genişlik
- Tam Genişlik: -1 (-1'ten geçmek, küçük resmin genişliğinin azaltılmadığı anlamına gelir)
height - sonuçtaki küçük resmin piksel cinsinden yüksekliği
- Varsayılan: hem çıktı genişliği hem de çıktı yüksekliği belirtilmezse veya 0 ise, çıktı genişliği ve yüksekliği son görüntü genişliği ve yüksekliğiyle eşleşir, çıktı genişliği belirtilirse çıktı yüksekliği çıktı genişliğiyle orantılı olur
- Maksimum: Paket için maksimum yükseklik
- Tam Boy: -1 (-1'ten geçmek, küçük resmin yüksekliğinin azaltılmadığı anlamına gelir)
format - ekran görüntüsünün içinde olması gereken format.
- Varsayılan: "jpg"
- Seçenekler: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
clickElement - bu, bir kullanarak HTML öğesini belirtir CSS seçici tıklamak. Tıklamanın etkilerini görmek için de bir gecikme gerekebileceğini unutmayın.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
targetElement - CSS seçici döndürülecek hedef web sayfasındaki tek HTML öğesinin açıklaması into bir ekran görüntüsü, web sayfasının diğer tüm bölümleri göz ardı edilir. Birden fazla eşleşen HTML öğesi varsa, ilki seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
customWaterMarkId - ekle görenek watermark or özel watermark görüntüye
- Varsayılan: boş
quality - döndürülen görüntünün kalitesi. Bu, şu anda yalnızca varsayılan sıkıştırması% 90 olan JPG ve WEBP görüntülerini etkiler.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
transparent - eğer doğruysa görüntü yakalama şeffaf olmalıdır. Bu sadece png ve tiff görüntüleriyle uyumludur.
- Varsayılan: yanlış
hd - eğer görüntü doğruysa yakalama yüksek çözünürlükte olacak bu, görüntü boyutlarının boyutunu ikiye katlar.
- Varsayılan: yanlış
country - ülke ekran görüntüsü alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Genel Yöntemler

add_post_parameter (ad, değer) - Bir HTTP Post parametresini ve isteğe bağlı olarak değeri tanımlar, bu yönteme birden fazla parametre eklemek için birden fazla kez çağrılabilir. Bu yöntemi kullanmak GrabzIt’ı zorlayacaktır. HTTP gönderisi gerçekleştir.
- name - HTTP Post parametresinin adı
- değer - HTTP Post parametresinin değeri

url_to_rendered_html(Url seçenekleri = sıfır)

Dönüştürülmesi gereken URL’yi belirtir into işlenmiş HTML.

parametreler

url - işlenen HTML’nin yapılması gereken URL
- gereklidir
seçenekleri - bir örneği HTMLOptions Oluşturulan HTML'yi oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

html_to_rendered_html(HTML, seçenekleri = sıfır)

Dönüştürülmesi gereken HTML'yi belirtir into işlenmiş HTML.

parametreler

html - dönüştürülecek HTML into render HTML
- gereklidir
seçenekleri - bir örneği HTMLOptions işlenmiş HTML oluştururken kullanılacak herhangi bir özel seçeneği tanımlayan sınıf.

Geri dönüş değeri

geçersiz

file_to_rendered_html(yol, yörünge, seçenekleri = sıfır)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into işlenmiş HTML.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into render HTML
- gereklidir
seçenekleri - bir örneği HTMLOptions işlenmiş HTML oluştururken kullanılacak herhangi bir özel seçeneği tanımlayan sınıf.

Geri dönüş değeri

geçersiz

HTMLOptions

Sınıf, ne zaman kullanılabilir durumda olan seçeneklerin tümünü temsil eder. işlenmiş HTML yakalama oluşturma.

Genel Mülkler

customId - Web servisine aktarabileceğiniz özel tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
browserWidth - tarayıcının piksel cinsinden genişliği
- Varsayılan: 1366
- Maksimum: 10000
browserHeight - tarayıcının piksel cinsinden yüksekliği
- Varsayılan: 1170
- Maksimum: 10000
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
country - ülke ekran görüntüsü alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Genel Yöntemler

add_post_parameter (ad, değer) - Bir HTTP Post parametresini ve isteğe bağlı olarak değeri tanımlar, bu yönteme birden fazla parametre eklemek için birden fazla kez çağrılabilir. Bu yöntemi kullanmak GrabzIt’ı zorlayacaktır. HTTP gönderisi gerçekleştir.
- name - HTTP Post parametresinin adı
- değer - HTTP Post parametresinin değeri

url_to_pdf(Url seçenekleri = sıfır)

Dönüştürülmesi gereken URL’yi belirtir into bir PDF.

parametreler

url - dönüştürülmesi gereken URL into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir PDFOptions sınıfı örneği.

Geri dönüş değeri

geçersiz

html_to_pdf(HTML, seçenekleri = sıfır)

Dönüştürülmesi gereken HTML'yi belirtir into bir PDF.

parametreler

html - dönüştürülecek HTML into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir PDFOptions sınıfı örneği.

Geri dönüş değeri

geçersiz

file_to_pdf(yol, yörünge, seçenekleri = sıfır)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir PDF.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir PDF
- gereklidir
seçenekleri - PDF oluştururken kullanılacak özel seçenekleri tanımlayan bir PDFOptions sınıfı örneği.

Geri dönüş değeri

geçersiz

PDFOptions

Sınıf, PDF yakalamalarını oluştururken mevcut seçeneklerin tümünü temsil eder.

Genel Mülkler

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
includeBackground - doğruysa, web sayfasının arka planı ekran görüntüsüne dahil edilmelidir
- Varsayılan: doğru

pagesize - PDF'nin sayfa boyutu
- Varsayılan: "A4"
- Seçenekler: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - PDF belgesinin yönlendirilmesi
- Varsayılan: "Portre"
- Seçenekler: "Portre", "Manzara"
cssMediaType - PDF belgesinin CSS Medya Türü
- Varsayılan ekran"
- Seçenekler: "Ekran", "Print"
includeLinks - Bağlantılar PDF'ye dahil edildiyse geçerlidir
- Varsayılan: doğru
includeOutline - eğer doğru PDF yer imleri yer verilmeli
- Varsayılan: yanlış
title - PDF belgesine bir başlık girin
- Varsayılan: boş
coverURL - PDF için kapak sayfası olarak kullanılması gereken bir web sayfasının URL'si
- Varsayılan: boş
marginTop - PDF belge sayfasının en üstünde görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginLeft - PDF belgesi sayfasının solunda görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginBottom - PDF belge sayfasının altında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginRight - PDF belgesinin sağında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
browserWidth - tarayıcının genişliği piksel cinsinden
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: 1366
- Maksimum: 10000
- Otomatik Genişlik: -1 (-1'ten geçmek, tarayıcının genişliğinin PDF belgesinin genişliğiyle eşleştiğini belirtir)
pageWidth - PDF'nin özel genişliği mm olarak
- Varsayılan: sayfa boyutu genişlik
- Minimum: 15
pageHeight - PDF'nin özel yüksekliği mm olarak
- Varsayılan: sayfa boyutu yükseklik
- Minimum: 15
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
templateId - ekle şablon PDF belgesinin üstbilgisini ve altbilgisini belirleyen kimlik
- Varsayılan: boş
clickElement - bu, bir kullanarak HTML öğesini belirtir CSS seçici tıklamak. Tıklamanın etkilerini görmek için de bir gecikme gerekebileceğini unutmayın.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
targetElement - CSS seçici sadece Hedef web sayfasında döndürülecek HTML öğesi into bir PDF, web sayfasının diğer tüm bölümleri yok sayılır. Birden fazla eşleşen HTML öğesi varsa, ilk öğe seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
customWaterMarkId - ekle görenek watermark or özel watermark PDF belgesinin her sayfasına
- Varsayılan: boş
quality - iade edilen PDF'nin kalitesi. Varsayılan ayar, bir PDF için önerilen kaliteyi kullanır.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke ekran görüntüsü alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş
mergeId - olması gereken bir yakalamanın kimliği yeni PDF belgesinin başında birleştirildi
- Varsayılan: boş
password - PDF belgesini korumak için parola ile
- Varsayılan: boş

Genel Yöntemler

add_post_parameter (ad, değer) - Bir HTTP Post parametresini ve isteğe bağlı olarak değeri tanımlar, bu yönteme birden fazla parametre eklemek için birden fazla kez çağrılabilir. Bu yöntemi kullanmak GrabzIt’ı zorlayacaktır. HTTP gönderisi gerçekleştir.
- name - HTTP Post parametresinin adı
- değer - HTTP Post parametresinin değeri
add_template_parameter (ad, değer) - tanımla özel şablon parametre ve değer, bu yöntem birden çok parametre eklemek için birden çok kez çağrılabilir.
- isim - şablon parametresinin ismi
- değer - şablon parametresinin değeri

url_to_docx(Url seçenekleri = sıfır)

Dönüştürülmesi gereken URL’yi belirtir into bir DOCX.

parametreler

url - dönüştürülmesi gereken URL into bir DOCX
- gereklidir
seçenekleri - bir örneği DOCXOptions DOCX oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

html_to_docx(HTML, seçenekleri = sıfır)

Dönüştürülmesi gereken HTML'yi belirtir into bir DOCX.

parametreler

html - dönüştürülecek HTML into bir DOCX
- gereklidir
seçenekleri - bir örneği DOCXOptions DOCX oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

file_to_docx(yol, yörünge, seçenekleri = sıfır)

Dönüştürülmesi gereken bir HTML dosyasını belirtir into bir DOCX.

parametreler

path - dönüştürülecek HTML dosyasının dosya yolu into bir DOCX
- gereklidir
seçenekleri - bir örneği DOCXOptions DOCX oluştururken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

DOCXOptions

Sınıf, DOCX yakalamalarını oluştururken mevcut tüm seçenekleri temsil eder.

Genel Mülkler

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecektir.
- Varsayılan: boş
includeBackground - doğruysa, web sayfasının arka plan görüntüleri DOCX’e dahil edilmelidir
- Varsayılan: doğru
pagesize - DOCX’in sayfa boyutu
- Varsayılan: "A4"
- Seçenekler: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
orientation - DOCX dokümanının yönlendirilmesi
- Varsayılan: "Portre"
- Seçenekler: "Portre", "Manzara"
includeLinks - linkler DOCX’e dahil edildiyse geçerlidir
- Varsayılan: doğru
includeImages - doğruysa, web sayfasının görüntüleri DOCX’e dahil edilmelidir
- Varsayılan: doğru
title - DOCX belgesine bir başlık verin
- Varsayılan: boş
marginTop - DOCX belge sayfasının en üstünde görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginLeft - DOCX belge sayfasının solunda görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginBottom - DOCX belge sayfasının altında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
marginRight - DOCX belgesinin sağında görünmesi gereken milimetre cinsinden kenar boşluğu
- Varsayılan: 10
browserWidth - tarayıcının genişliği piksel cinsinden
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
- Varsayılan: 1366
- Maksimum: 10000
- Otomatik Genişlik: -1 (-1'ten geçmek, tarayıcının genişliğinin DOCX belgesinin genişliği ile eşleştiği anlamına gelir)
pageWidth - ortaya çıkan DOCX'in özel genişliği mm olarak
- Varsayılan: sayfa boyutu genişlik
- Minimum: 15
pageHeight - elde edilen DOCX'in özel yüksekliği mm olarak
- Varsayılan: sayfa boyutu yükseklik
- Minimum: 15
delay - milisaniye ekran görüntüsünü almadan önce bekleyin
- Varsayılan: 0
- Maksimum: 30000
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
templateId - ekle şablon DOCX belgesinin üstbilgisini ve altbilgisini belirten kimlik
- Varsayılan: boş
clickElement - bu, bir kullanarak HTML öğesini belirtir CSS seçici tıklamak. Tıklamanın etkilerini görmek için de bir gecikme gerekebileceğini unutmayın.
- Bu özelliğin uyarısı şu anda beta aşamasındadır ve tutarlı sonuçlar vermeyebilir.
targetElement - CSS seçici döndürülecek hedef web sayfasındaki tek HTML öğesinin açıklaması into DOCX'te, web sayfasının diğer tüm bölümleri göz ardı edilir. Birden fazla eşleşen HTML öğesi varsa, ilki seçilir
- Varsayılan: boş
hideElement - CSS seçicileri Web sayfasındaki bir veya daha fazla HTML öğesinin gizlenmesini, gizlenecek birden çok HTML öğesinin belirtilmesini sağlamak için her seçiciyi virgülle ayırın
- Varsayılan: boş
waitForElement - CSS seçicileri web sayfasındaki HTML öğesinin yakalama gerçekleştirilmeden önce görünür olmalıdır
- Varsayılan: boş
quality - iade edilen DOCX'in kalitesi. Varsayılan, bir DOCX için önerilen kaliteyi kullanır.
- Kaliteyi düşürmek dosya boyutunu azaltır ve indirme sürelerini azaltır.
- Varsayılan: -1
- Minimum: -1
- Maksimum: 100
country - ülke ekran görüntüsü alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
noAds - Eğer doğruysa reklamlar otomatik olarak gizlenmeli.
- Varsayılan: yanlış
noCookieNotifications - doğruysa, yaygın olarak bulunanlar: çerez bildirimleri otomatik olarak gizlenmelidir.
- Varsayılan: yanlış
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş
mergeId - olması gereken bir yakalamanın kimliği yeni DOCX belgesinin başında birleştirildi
- Varsayılan: boş
password - DOCX belgesini korumak için parola ile
- Varsayılan: boş

Genel Yöntemler

add_post_parameter (ad, değer) - Bir HTTP Post parametresini ve isteğe bağlı olarak değeri tanımlar, bu yönteme birden fazla parametre eklemek için birden fazla kez çağrılabilir. Bu yöntemi kullanmak GrabzIt’ı zorlayacaktır. HTTP gönderisi gerçekleştir.
- name - HTTP Post parametresinin adı
- değer - HTTP Post parametresinin değeri
add_template_parameter (ad, değer) - tanımla özel şablon parametre ve değer, bu yöntem birden çok parametre eklemek için birden çok kez çağrılabilir.
- isim - şablon parametresinin ismi
- değer - şablon parametresinin değeri

url_to_table(Url seçenekleri = sıfır)

HTML tablolarının çıkarılması gereken URL'yi belirtir.

parametreler

url - HTML tablolarını çıkartmak için kullanılacak URL
- gereklidir
seçenekleri - bir örneği TableOptions HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

html_to_table(HTML, seçenekleri = sıfır)

HTML tablolarının çıkartılması gereken HTML'yi belirtir.

parametreler

html - HTML tablolarından çıkartılacak HTML.
- gereklidir
seçenekleri - bir örneği TableOptions HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

file_to_table(yol, yörünge, seçenekleri = sıfır)

HTML tablolarının çıkartılması gereken bir HTML dosyası belirtir.

parametreler

yol - HTML tablolarını ayıklamak için bir HTML dosyasının dosya yolu.
- gereklidir
seçenekleri - bir örneği TableOptions HTML tablosunu dönüştürürken kullanılacak özel seçenekleri tanımlayan sınıf.

Geri dönüş değeri

geçersiz

TableOptions

Sınıf, HTML tablolarını CSV, XLSX veya JSON'a dönüştürürken mevcut seçeneklerin tümünü temsil eder.

Genel Mülkler

customId - web servisine iletebileceğiniz özel bir tanımlayıcı. Bu, belirttiğiniz geri arama URL’si ile döndürülecek
- Varsayılan: boş
tableNumberToInclude - dönüştürülecek tablonun dizini, bir web sayfasındaki tüm tablolar web sayfasının başından sonuna doğru sipariş edildi.
- Varsayılan: 1
format - tablonun içinde olması gereken format
- Varsayılan: "csv"
- Seçenekler: "csv", "json", "xlsx"
includeHeaderNames - eğer gerçek başlık isimleri tabloya dahil edilecekse
- Varsayılan: doğru
includeAllTables - doğruysa, web sayfasındaki tüm tabloların her biri ayrı bir e-tablo sayfasında görünecek şekilde çıkarılacaktır. Yalnızca XLSX formatıyla kullanılabilir
- Varsayılan: yanlış
targetElement - web sayfasındaki tabloları çıkarmak için kullanılması gereken tek HTML öğesinin kimliği
- Varsayılan: boş
requestAs - kullanmak istediğiniz kullanıcı aracısının türü
- Varsayılan: 0
- Seçenekler:
  - 0 = standart bir tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 1 = bir mobil tarayıcının kullanıcı aracısının kullanılması gerektiğini belirtir
  - 2 = bir arama motorunun kullanıcı aracısının kullanılması gerektiğini gösterir
country - ülke ekran görüntüsü alınmalıdır.
- Varsayılan: Geçerli en hızlı konum
- Seçenekler: "SG", "İngiltere", "ABD"
exportURL - URL’yi dışa aktar Bu, yakalamanın nerede dışa aktarılacağını da belirtir.
- Varsayılan: boş
encryptionKey - bir temel 64 kodlu AES şifreleme anahtarı belirtilmişse, yakalamanız oluşturulduğunda şifrelenmişse. Kullanılması önerilir. şifreleme anahtarı yöntemi oluştur anahtarı ve şifre çözme yöntemleri şifreli yakalamanın şifresini çözmek için bu örnek.
- Varsayılan: boş
address - HTML kodunu çalıştırmak için kullanılacak URL. Dönüştürülmekte olan HTML kullanıyorsa yararlı olabilir. göreli URL'ler, CSS ve görüntüler gibi kaynaklar için.
- Varsayılan: boş
proxy - HTTP vekil detayları tarayıcı yazılımı bu yakalamayı oluşturmak için kullanmak için kullanmalıdır
- Varsayılan: boş

Genel Yöntemler

add_post_parameter (ad, değer) - Bir HTTP Post parametresini ve isteğe bağlı olarak değeri tanımlar, bu yönteme birden fazla parametre eklemek için birden fazla kez çağrılabilir. Bu yöntemi kullanmak GrabzIt’ı zorlayacaktır. HTTP gönderisi gerçekleştir.
- name - HTTP Post parametresinin adı
- değer - HTTP Post parametresinin değeri

Bir dosyayı kaydetmenin önerilen yöntemi budur

save(callBackURL = nil)

Save Sonuç, zaman uyumsuz olarak ve ekran görüntüsünü almak için kullanılabilecek benzersiz bir tanımlayıcı döndürür. get_result yöntemi.

parametreler

callBackURL - işleyicisi GrabzIt servisi, çalışmalarını tamamladıktan sonra aramalıdır.

Geri dönüş değeri

Ekran görüntüsünün benzersiz tanımlayıcısı aksi halde bir hata oluştuğunda bir istisna atılır. Bu, ekran görüntüsünü get_result yöntemiyle elde etmek için kullanılabilir.

Uyarı Bu yöntemin senkronize olması nedeniyle sonuç işlenirken uygulamanın duraklatılmasına neden olur

save_to()

Save Sonuç, ekran görüntüsü bayt verisini içeren bir değişkenle senkronize olarak sonuçlanır.

Geri dönüş değeri

Başarılı olursa dosyanın bayt verilerini döndürür, aksi takdirde bir istisna atar.

Uyarı Bu yöntemin senkronize olması nedeniyle sonuç işlenirken uygulamanın duraklatılmasına neden olur

save_to(saveToDosya)

Save Sonuç bir dosyaya senkronize olarak.

parametreler

saveToDosya - yakalanacak dosya yolu saved bittiğinde
- gereklidir

Geri dönüş değeri

başarılı olursa true değerini döndürür, aksi takdirde bir istisna atar.

get_status(İD)

GrabzIt ekran görüntüsünün geçerli durumunu öğrenin.

parametreler

id - ekran görüntüsünün benzersiz tanımlayıcısı
- gereklidir

Geri dönüş değeri

ScreenShotStatus nesne

get_cookies(alan adı)

GrabzIt'ın belirli bir etki alanı için kullandığı tüm çerezleri edinin. Bu, kullanıcı tanımlı çerezleri de içerebilir.

parametreler

etki alanı - için çerezleri döndürecek etki alanı
- gereklidir

Geri dönüş değeri

kurabiye dizi

set_cookie (ad, etki alanı, değer = "", yol = "/", httponly = false, kullanım süresi = "")

Özel çerez, genel çerezle aynı adı ve etki alanına sahipse GrabzIt üzerine yeni bir özel çerez ayarlar, global çerez geçersiz kılınır.

Bir web sitesi işlevselliği çerezler tarafından kontrol ediliyorsa bu yararlı olabilir.

parametreler

isim - ayarlanacak çerezin ismi
- gereklidir
etki alanı - Çerezin ayarlanacağı web sitesinin etki alanı
- gereklidir
değer - çerezin değeri
yol - Çerezin ilgili olduğu web sitesi
httponly - true ise, çerez sadece HTTP protokolü ile kullanılabilir.
zaman aşımına uğradı - tanımlama bilgisinin süresinin dolmasını tanımlar. Çerezin süresinin dolmaması gerekiyorsa bir nil değeri iletin
- Yyyy-aa-gg ssHd: mm: ss biçiminde olması gerekir

Geri dönüş değeri

Tanımlama bilgisi başarıyla ayarlandıysa doğru, aksi takdirde yanlış

delete_cookie (ad, etki alanı)

Özel bir çerezi silin veya global bir çerezin kullanılmasını engelleyin

parametreler

isim - silinecek çerezin ismi
- gereklidir
alan - web sitesinin, alandaki tanımlama bilgisini silmek üzere etki alanı
- gereklidir

parametreler

veri - şifreli baytlar
- gereklidir
anahtar - şifreleme anahtarı
- gereklidir

decrypt_file (yol, anahtar)

Sağlanan şifreleme anahtarını kullanarak şifreli bir yakalamanın şifresini çözün.

parametreler

yol - şifreli yakalamanın yolu
- gereklidir
anahtar - şifreleme anahtarı
- gereklidir

Sonuç Sınıfları

kurabiye

Genel Mülkler

name
- Çerez adı.
value
- Çerez değeri.
domain
- Çerezin ayarlandığı etki alanı.
path
- Bu çerezin geçerli olduğu alandaki yol.
httpOnly
- Bu çerez sadece web sitesi HTTP protokolüyle görüntülendiğinde geçerlidir.
expires
- Bu çerezin sona erdiği tarih
type
- Aşağıdakilerden biri olabilen çerez türü budur:
  - Global - Bu, GrabzIt tarafından belirlenen global bir çerezdir.
  - Yerel - bu sizin tarafınızdan belirlenen yerel bir çerezdir
  - Geçersiz kıl - sizin tarafınızdan geçersiz kılınan küresel bir çerez

ScreenShotStatus

Ekran görüntüsünün geçerli durumunu temsil eden sınıf.

Genel Mülkler

processing
- Doğruysa, ekran görüntüsü hala işleniyor.
cached
- Doğruysa, ekran görüntüsü işlendi ve şu anda önbellekte saklanıyor.
expired
- Doğruysa, ekran görüntüsü artık GrabzIt sisteminde değildir.
message
- Sistem tarafından döndürülen bir hata mesajı.

WaterMark

Bu sınıf, özel watermarks GrabzIt'te depolandı

Genel Mülkler

identifier
- Tanımlayıcı watermark
xPosition
- Yatay konumu watermark
  - Sol = 0
  - Merkez = 1
  - Sağ = 2
yPosition
- Dikey konumu watermark
  - Üst = 0
  - Orta = 1
  - Alt = 2
format
- Biçimi watermark