Narzędzia do przechwytywania i konwertowania Internetu

Klient z PerlemPerl API

Opis

Ta klasa obsługuje całą komunikację z usługami zrzutów ekranu GrabzIt.

Metody publiczne

GetResult($ id)

Ta metoda zwraca sam zrzut ekranu. Jeśli nic nie zostanie zwrócone, oznacza to, że coś poszło nie tak lub zrzut ekranu nie jest jeszcze gotowy.

parametry

  • id - unikalny identyfikator zrzutu ekranu
    • wymagany

Wartość zwracana

Schwytanie


URLToAnimation($ url, Opcje $)

Określ adres URL wideo online, które należy przekonwertować into animowany GIF.

parametry

  • url - adres URL wideo online do konwersji into animowany GIF.
    • wymagany
    • Akceptuje adresy URL wideo Vimeo i YouTube
      • Ostrzeżenie dotyczące animowania filmów Vimeo i YouTube zależy od strony trzeciej, dlatego może nie zapewniać spójnych wyników.
  • Opcje - instancja GrabzItAnimationOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia animowanego GIF-a.

Wartość zwracana

unieważnić

GrabzItAnimationOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia animowanego GIF-a.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do animowanej usługi internetowej GIF. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
    • Domyślnie: pusty
  • width($value) - szerokość wynikowego animowanego GIF-a w pikselach.
    • Domyślnie: 180px
    • Maksymalna: maksymalna szerokość paczki
    • Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że ​​szerokość animowany GIF jest skalowany w stosunku do jego wysokości, jeśli szerokość jest automatycznie dopasowywana, wysokość nie może)
  • height($value) - wysokość powstałego animowanego GIF-a w pikselach.
    • Domyślnie: 120px
    • Maksymalna: maksymalna wysokość paczki
    • Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że ​​wysokość animowany GIF jest skalowany w stosunku do szerokości, jeśli wysokość jest automatycznie dopasowywana, szerokość nie może)
  • start($value) - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
    • Domyślnie: 0 sekund
  • duration($value) - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
    • Domyślnie: maksymalna długość paczki
  • speed($value) - prędkość animowanego GIF-a.
    • Domyślnie: 1
    • Minimum: 0.2
    • Maksymalna ilość znaków: 10
  • framesPerSecond($value) - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
    • Domyślnie: 10
    • Minimum: 0.2
    • Maksymalna ilość znaków: 60
  • repeat($value) - ile razy zapętlono animowany GIF.
    • Domyślnie: 0
    • Pętla w sposób ciągły: 0
  • reverse($value) - jeśli 1 ramki animowanego GIF-a są odwrócone
    • Domyślnie: 0
  • customWaterMarkId($value) - dodaj niestandardowy znak wodny do animowanego GIF-a
    • Domyślnie: pusty
  • quality($value) - w jakość zwróconego obrazu, który ma domyślną kompresję 85%.
    • Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
    • Domyślnie: -1
    • Minimum: -1
    • Maksymalna ilość znaków: 100
  • country($value) - kraj animowany GIF powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Ponieważ Perl ma słabe macierzyste funkcje szyfrowania, musisz postępuj zgodnie z tymi instrukcjami aby odszyfrować zaszyfrowane przechwycenie.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

URLToImage($ url, Opcje $)

Określa adres URL, który należy przekonwertować into zrzut ekranu obrazu.

parametry

  • url - adres URL, z którego należy wykonać zrzut ekranu
    • wymagany
  • Opcje - instancja GrabzItImageOptions klasa, która definiuje specjalne opcje do użycia podczas tworzenia zrzutu ekranu.

Wartość zwracana

unieważnić

HTMLToImage($ html, Opcje $)

Określa kod HTML, który należy przekonwertować into obrazie.

parametry

  • HTML - kod HTML do konwersji into obrazie
    • wymagany
  • Opcje - instancja GrabzItImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

FileToImage($ path, Opcje $)

Określa plik HTML, który należy przekonwertować into obrazie.

parametry

  • ścieżka - ścieżka pliku HTML do konwersji into obrazie
    • wymagany
  • Opcje - instancja GrabzItImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.

Wartość zwracana

unieważnić

GrabzItImageOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów obrazu.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do usługi zrzutów ekranu. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
    • Domyślnie: pusty
  • browserWidth($value) - szerokość przeglądarki w pikselach
    • Domyślnie: 1024
    • Maksymalna ilość znaków: 10000
  • browserHeight($value) - wysokość przeglądarki w pikselach
    • Domyślnie: 768
    • Maksymalna ilość znaków: 10000
    • Pełna długość: -1 (przekazanie -1 oznacza, że ​​wykonano sceenshot całej strony)
  • width($value) - szerokość wynikowej miniatury w pikselach
    • Domyślnie: najwyższy możliwy stosunek szerokości przeglądarki, który mieści się w maksymalnej szerokości pakietu użytkowników
    • Maksymalna: maksymalna szerokość paczki
    • Pełna szerokość: -1 (przekazanie -1 oznacza, że ​​szerokość miniatury nie jest zmniejszona)
  • height($value) - wysokość powstałej miniatury w pikselach
    • Domyślnie: najwyższy możliwy stosunek wysokości przeglądarki, który mieści się w maksymalnej wysokości dla pakietu użytkowników
    • Maksymalna: maksymalna wysokość paczki
    • Pełna wysokość: -1 (przekazanie -1 oznacza, że ​​wysokość miniatury nie jest zmniejszona)
  • format($value) - format, w jakim powinien być zrzut ekranu.
    • Domyślnie: „jpg”
    • Opcje: „bmp8”, „bmp16”, „bmp24”, „bmp”, „tiff”, „webp”, „jpg”, „png”
  • delay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
    • Domyślnie: 0
    • Maksymalna ilość znaków: 30000
  • targetElement($value) - identyfikator lub klasa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into zrzut ekranu, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
    • Domyślnie: pusty
  • hideElement($value) - identyfikator lub klasa Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
    • Domyślnie: pusty
  • waitForElement($value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • requestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
    • Domyślnie: 0
    • Opcje:
      • 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
      • 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
      • 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
      • 3 = wskazuje, że należy użyć klienta użytkownika podstawowej przeglądarki
  • customWaterMarkId($value) - dodaj niestandardowy znak wodny do obrazu
    • Domyślnie: pusty
  • quality($value) - w jakość zwróconego obrazu. To obecnie wpływa tylko na obrazy JPG, które mają domyślną kompresję 85%.
    • Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
    • Domyślnie: -1
    • Minimum: -1
    • Maksymalna ilość znaków: 100
  • transparent($value) - jeśli 1 przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
    • Domyślnie: 0
  • hd($value) - jeśli 1 obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
    • Domyślnie: 0
  • country($value) - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Ponieważ Perl ma słabe macierzyste funkcje szyfrowania, musisz postępuj zgodnie z tymi instrukcjami aby odszyfrować zaszyfrowane przechwycenie.
    • Domyślnie: pusty
  • noAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • noCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • address($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli konwertowany HTML używa względnych adresów URL do zasobów takich jak CSS i obrazy.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

Metody publiczne

  • AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
    • name - nazwa parametru HTTP Post
    • wartość - wartość parametru HTTP Post

URLToRenderedHTML($ url, Opcje $ = null)

Określa adres URL, który należy przekonwertować into renderowany HTML.

parametry

  • url - adres URL, z którego powinien być wykonany renderowany HTML
    • wymagany
  • Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

HTMLToRenderedHTML($ html, Opcje $ = null)

Określa kod HTML, który należy przekonwertować into renderowany HTML.

parametry

  • HTML - kod HTML do konwersji into renderowany HTML
    • wymagany
  • Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

FileToRenderedHTML($ path, Opcje $ = null)

Określa plik HTML, który należy przekonwertować into renderowany HTML.

parametry

  • ścieżka - ścieżka pliku HTML do konwersji into renderowany HTML
    • wymagany
  • Opcje - instancja GrabzItHTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.

Wartość zwracana

unieważnić

GrabzItHTMLOptions

Klasa reprezentuje wszystkie opcje dostępne, kiedy tworzenie renderowanych zrzutów HTML.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
    • Domyślnie: pusty
  • browserWidth($value) - szerokość przeglądarki w pikselach
    • Domyślnie: 1024
    • Maksymalna ilość znaków: 10000
  • browserHeight($value) - wysokość przeglądarki w pikselach
    • Domyślnie: 768
    • Maksymalna ilość znaków: 10000
  • delay($value) - liczba milisekund do poczekaj przed wykonaniem zdjęcia
    • Domyślnie: 0
    • Maksymalna ilość znaków: 30000
  • waitForElement($value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • requestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
    • Domyślnie: 0
    • Opcje:
      • 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
      • 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
      • 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
      • 3 = wskazuje, że należy użyć klienta użytkownika podstawowej przeglądarki
  • country($value) - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, twoje przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
    • Domyślnie: pusty
  • noAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • noCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • address($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

Metody publiczne

  • AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
    • name - nazwa parametru HTTP Post
    • wartość - wartość parametru HTTP Post

URLToPDF($ url, Opcje $)

Określa adres URL, który należy przekonwertować into PDF.

parametry

  • url - adres URL, który należy przekonwertować into PDF
    • wymagany
  • Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

HTMLToPDF($ html, Opcje $)

Określa kod HTML, który należy przekonwertować into PDF.

parametry

  • HTML - kod HTML do konwersji into PDF
    • wymagany
  • Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

FileToPDF($ path, Opcje $)

Określa plik HTML, który należy przekonwertować into PDF.

parametry

  • ścieżka - ścieżka pliku HTML do konwersji into PDF
    • wymagany
  • Opcje - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.

Wartość zwracana

unieważnić

GrabzItPDFOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów PDF.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
    • Domyślnie: pusty
  • includeBackground($value) - jeśli 1, tło strony internetowej powinno być zawarte w pliku PDF
    • Domyślnie: 1
  • pagesize($value) - rozmiar strony pliku PDF
    • Domyślnie: „A4”
    • Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
  • orientation($value) - orientacja dokumentu PDF
    • Domyślnie: „Portret”
    • Opcje: „Portret”, „Krajobraz”
  • cssMediaType($value) - w CSS Media Typ dokumentu PDF
    • Ekran domyślny"
    • Opcje: „Ekran”, „Parint"
  • includeLinks($value) - 1, jeśli linki powinny być zawarte w pliku PDF
    • Domyślnie: 1
  • includeOutline($value) - 1 jeśli Zakładki PDF powinno być dołączone
    • Domyślnie: 0
  • title($value) - podać tytuł dokumentu PDF
    • Domyślnie: pusty
  • coverURL($value) - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
    • Domyślnie: pusty
  • marginTop($value) - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
    • Domyślnie: 10
  • marginLeft($value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
    • Domyślnie: 10
  • marginBottom($value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
    • Domyślnie: 10
  • marginRight($value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
    • Domyślnie: 10
  • browserWidth($value) - w szerokość przeglądarki w pikselach
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: 1024
    • Maksymalna ilość znaków: 10000
    • Automatyczna szerokość: -1 (przekazanie -1 oznacza, że ​​szerokość przeglądarki odpowiada szerokości dokumentu PDF)
  • pageWidth - w niestandardowa szerokość wynikowego pliku PDF w mm
  • pageHeight - w niestandardowa wysokość wynikowego pliku PDF w mm
  • delay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
    • Domyślnie: 0
    • Maksymalna ilość znaków: 30000
  • requestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
    • Domyślnie: 0
    • Opcje:
      • 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
      • 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
      • 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
      • 3 = wskazuje, że należy użyć klienta użytkownika podstawowej przeglądarki
  • templateId($value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
    • Domyślnie: pusty
  • targetElement($value) - identyfikator lub klasa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
    • Domyślnie: pusty
  • hideElement($value) - identyfikator lub klasa Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
    • Domyślnie: pusty
  • waitForElement($value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • customWaterMarkId($value) - dodaj niestandardowy znak wodny do każdej strony dokumentu PDF
    • Domyślnie: pusty
  • quality($value) - w jakość zwróconego pliku PDF. Domyślnie używana jest zalecana jakość pliku PDF.
    • Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
    • Domyślnie: -1
    • Minimum: -1
    • Maksymalna ilość znaków: 100
  • country($value) - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Ponieważ Perl ma słabe macierzyste funkcje szyfrowania, musisz postępuj zgodnie z tymi instrukcjami aby odszyfrować zaszyfrowane przechwycenie.
    • Domyślnie: pusty
  • noAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • noCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • address($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli konwertowany HTML używa względnych adresów URL do zasobów takich jak CSS i obrazy.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty
  • mergeId($value) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
    • Domyślnie: pusty
  • password($value) - w hasło do ochrony dokumentu PDF z
    • Domyślnie: pusty

Metody publiczne

  • AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
    • name - nazwa parametru HTTP Post
    • wartość - wartość parametru HTTP Post
  • AddTemplateParameter ($ nazwa, $ wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
    • name - nazwa parametru szablonu
    • wartość - wartość parametru szablonu

URLToDOCX ($ url, Opcje $)

Określa adres URL, który należy przekonwertować into DOCX.

parametry

  • url - adres URL, który należy przekonwertować into DOCX
    • wymagany
  • Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

HTMLToDOCX($ html, Opcje $)

Określa kod HTML, który należy przekonwertować into DOCX.

parametry

  • HTML - kod HTML do konwersji into DOCX
    • wymagany
  • Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

FileToDOCX($ path, Opcje $)

Określa plik HTML, który należy przekonwertować into DOCX.

parametry

  • ścieżka - ścieżka pliku HTML do konwersji into DOCX
    • wymagany
  • Opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.

Wartość zwracana

unieważnić

GrabzItDOCXOptions

Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia przechwytywania DOCX.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
    • Domyślnie: pusty
  • setIncludeBackground($value) - w przypadku 1 obrazy tła strony internetowej powinny zostać uwzględnione na zrzucie ekranu
    • Domyślnie: 1
  • pagesize($value) - rozmiar strony DOCX
    • Domyślnie: „A4”
    • Opcje: „A3”, „A4”, „A5”, „A6”, „B3”, „B4”, „B5”, „B6”, „Legal”, „Letter”
  • orientation($value) - orientacja dokumentu DOCX
    • Domyślnie: „Portret”
    • Opcje: „Portret”, „Krajobraz”
  • includeLinks($value) - 1, jeśli linki powinny być zawarte w DOCX
    • Domyślnie: 1
  • includeImages($value) - w przypadku 1 obrazy tła strony internetowej powinny zostać uwzględnione na zrzucie ekranu
    • Domyślnie: 1
  • title($value) - podać tytuł dokumentu DOCX
    • Domyślnie: pusty
  • marginTop($value) - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
    • Domyślnie: 10
  • marginLeft($value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
    • Domyślnie: 10
  • marginBottom($value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
    • Domyślnie: 10
  • marginRight($value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
    • Domyślnie: 10
  • browserWidth($value) - w szerokość przeglądarki w pikselach
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: 1024
    • Maksymalna ilość znaków: 10000
    • Automatyczna szerokość: -1 (przekazanie -1 oznacza, że ​​szerokość przeglądarki odpowiada szerokości dokumentu DOCX)
  • pageWidth - w niestandardowa szerokość wynikowego DOCX w mm
  • pageHeight - w niestandardowa wysokość wynikowego DOCX w mm
  • delay($value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
    • Domyślnie: 0
    • Maksymalna ilość znaków: 30000
  • requestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
    • Domyślnie: 0
    • Opcje:
      • 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
      • 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
      • 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
      • 3 = wskazuje, że należy użyć klienta użytkownika podstawowej przeglądarki
  • templateId($value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
    • Domyślnie: pusty
  • targetElement($value) - identyfikator lub klasa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into DOCX, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
    • Domyślnie: pusty
  • hideElement($value) - identyfikator lub klasa Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
    • Domyślnie: pusty
  • waitForElement($value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • quality($value) - w jakość zwróconego DOCX. Domyślnie używana jest zalecana jakość dla DOCX.
    • Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
    • Domyślnie: -1
    • Minimum: -1
    • Maksymalna ilość znaków: 100
  • country($value) - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Ponieważ Perl ma słabe macierzyste funkcje szyfrowania, musisz postępuj zgodnie z tymi instrukcjami aby odszyfrować zaszyfrowane przechwycenie.
    • Domyślnie: pusty
  • noAds($value) - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • noCookieNotifications($value) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • address($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli konwertowany HTML używa względnych adresów URL do zasobów takich jak CSS i obrazy.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty
  • mergeId($value) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
    • Domyślnie: pusty
  • password($value) - w hasło do ochrony dokumentu DOCX z
    • Domyślnie: pusty

Metody publiczne

  • AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
    • name - nazwa parametru HTTP Post
    • wartość - wartość parametru HTTP Post
  • AddTemplateParameter ($ nazwa, $ wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
    • name - nazwa parametru szablonu
    • wartość - wartość parametru szablonu

URLToTable($ url, Opcje $)

Określa adres URL, z którego należy wyodrębnić tabele HTML.

parametry

  • url - adres URL do wyodrębnienia tabel HTML
    • wymagany
  • Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

HTMLToTable ($ html, Opcje $)

Określa kod HTML, z którego należy wyodrębnić tabele HTML.

parametry

  • html - HTML, z którego można wyodrębnić tabele HTML.
    • wymagany
  • Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

FileToTable ($ path, Opcje $)

Określa plik HTML, z którego należy wyodrębnić tabele HTML.

parametry

  • ścieżka - ścieżka pliku HTML, z którego można wyodrębnić tabele HTML.
    • wymagany
  • Opcje - instancja GrabzItTableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.

Wartość zwracana

unieważnić

GrabzItTableOptions

Klasa reprezentuje wszystkie opcje dostępne podczas konwersji tabel HTML na CSV, XLSX lub JSON.

Właściwości publiczne

  • customId($value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego
    • Domyślnie: pusty
  • tableNumberToInclude($value) - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
    • Domyślnie: 1
  • format($value) - format, w jakim powinna być tabela
    • Domyślnie: „csv”
    • Opcje: „csv”, „json”, „xlsx”
  • includeHeaderNames($value) - jeśli nazwy nagłówków 1 zostaną uwzględnione w tabeli
    • Domyślnie: 1
  • includeAllTables($value) - jeśli 1 wszystkie tabele na stronie internetowej zostaną wyodrębnione, a każda tabela pojawi się w osobnym arkuszu kalkulacyjnym. Dostępne tylko w formacie XLSX
    • Domyślnie: 0
  • targetElement($value) - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
    • Domyślnie: pusty
  • requestAs($value) - rodzaj agenta użytkownika, którego chcesz używać
    • Domyślnie: 0
    • Opcje:
      • 0 = wskazuje, że należy użyć klienta użytkownika standardowej przeglądarki
      • 1 = wskazuje, że należy użyć klienta użytkownika przeglądarki mobilnej
      • 2 = wskazuje, że należy użyć klienta użytkownika wyszukiwarki
      • 3 = wskazuje, że należy użyć klienta użytkownika podstawowej przeglądarki
  • country($value) - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • Domyślnie: bieżąca najszybsza lokalizacja
    • Opcje: „SG”, „UK”, „US”
  • exportURL($value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
    • Domyślnie: pusty
  • encryptionKey($value) - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Ponieważ Perl ma słabe macierzyste funkcje szyfrowania, musisz postępuj zgodnie z tymi instrukcjami aby odszyfrować zaszyfrowane przechwycenie.
    • Domyślnie: pusty
  • address($value) - adres URL do wykonania kodu HTML. Może być przydatny, jeśli konwertowany HTML używa względnych adresów URL do zasobów takich jak CSS i obrazy.
    • Domyślnie: pusty
  • proxy($value) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

Metody publiczne

  • AddPostParameter ($ nazwa, $ wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
    • name - nazwa parametru HTTP Post
    • wartość - wartość parametru HTTP Post

Jest to zalecana metoda zapisywania pliku

Save($ callBackURL = '')

Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z GetResult Metoda.

parametry

  • callBackURL - treser usługa GrabzIt powinna zadzwonić po zakończeniu pracy

Wartość zwracana

Unikalny identyfikator zrzutu ekranu, w przeciwnym razie, jeśli wystąpi błąd, zgłoszony zostanie wyjątek. Można tego użyć, aby uzyskać zrzut ekranu z GetResult metoda


Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku

SaveTo()

Save wynik synchronicznie do zmiennej zawierającej dane bajtu zrzutu ekranu.

Wartość zwracana

zwraca dane bajtowe pliku, jeśli zakończy się powodzeniem, w przeciwnym razie zgłasza wyjątek.


Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku

SaveTo($saveDo pliku)

Save wynik synchronicznie do pliku.

parametry

  • saveToFile - ścieżka przechwytywania pliku saved po zakończeniu
    • wymagany

Wartość zwracana

zwraca 1, jeśli się powiedzie, w przeciwnym razie zgłasza wyjątek.


GetStatus ($ id)

Uzyskaj aktualny status zrzutu ekranu GrabzIt.

parametry

  • id - unikalny identyfikator zrzutu ekranu
    • wymagany

Wartość zwracana

GrabzItStatus przedmiot


GetCookies ($ domain)

Zdobądź wszystkie pliki cookie, których używa GrabzIt dla określonej domeny. Może to również obejmować pliki cookie zdefiniowane przez użytkownika.

parametry

  • domena - domena, dla której zwracane są pliki cookie
    • wymagany

Wartość zwracana

GrabzItCookie szyk


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

Ustawia nowy niestandardowy plik cookie w GrabzIt, jeśli niestandardowy plik cookie ma taką samą nazwę i domenę jak globalny plik cookie, globalny plik cookie zostanie zastąpiony.

Może to być przydatne, jeśli funkcjonalność strony internetowej jest kontrolowana przez pliki cookie.

parametry

  • nazwa - nazwa pliku cookie, który należy ustawić
    • wymagany
  • domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
    • wymagany
  • wartość - wartość pliku cookie
  • ścieżka - ścieżka do strony, której dotyczy plik cookie
  • httponly - w przypadku 1 plik cookie może być używany tylko z protokołem HTTP
  • wygasa - określa, kiedy wygasa plik cookie. Podaj wartość zerową, jeśli plik cookie nie wygasa
    • Powinien być w formacie rrrr-mm-dd gg: mm: ss

Wartość zwracana

1, jeśli plik cookie został pomyślnie ustawiony, w przeciwnym razie 0


DeleteCookie ($ name, $ domain)

Usuń niestandardowy plik cookie lub zablokuj używanie globalnego pliku cookie

parametry

  • nazwa - nazwa pliku cookie do usunięcia
    • wymagany
  • domena - domena strony internetowej, dla której chcesz usunąć plik cookie
    • wymagany

Wartość zwracana

1, jeśli plik cookie zostanie pomyślnie usunięty, w przeciwnym razie 0


OtrzymaćWaterMarks()

Uzyskaj przesłane niestandardowe znaki wodne

Wartość zwracana

GrabzItWaterMark szyk


OtrzymaćWaterMark($ identyfikator)

Zwróć niestandardowe znaki wodne, które pasują do określonego identyfikatora

parametry

  • identyfikator - identyfikator określonego niestandardowego znaku wodnego, który chcesz wyświetlić
    • wymagany

Wartość zwracana

GrabzItWaterMark


dodaćWaterMark($ identyfikator, $ ścieżka, $ xpos, $ ypos)

Dodaj nowy niestandardowy znak wodny

parametry

  • identyfikator - identyfikator, który chcesz nadać niestandardowemu znakowi wodnemu. Ważne jest, aby ten identyfikator był unikalny.
    • wymagany
  • ścieżka - bezwzględna ścieżka znaku wodnego na twoim serwerze. Na przykład C: /watermark/1.png
    • wymagany
  • xpos - pozycja pozioma, na której ma się pojawić zrzut ekranu
    • wymagany
    • Opcje:
      • Lewy = 0
      • Centrum = 1
      • Prawo = 2
  • ypos - pozycja pionowa, w której ma się pojawić zrzut ekranu
    • wymagany
    • Opcje:
      • Góra = 0
      • Middle = 1
      • Dół = 2

Wartość zwracana

zwraca 1, jeśli znak wodny został pomyślnie ustawiony


DeleteWaterMark($ identyfikator)

Usuń niestandardowy znak wodny

parametry

  • identyfikator - identyfikator niestandardowego znaku wodnego, który chcesz usunąć
    • wymagany

Wartość zwracana

zwraca 1, jeśli znak wodny został pomyślnie usunięty


UseSSL (wartość $)

Określa, czy żądania do GrabzIt's Interfejs API powinien używać protokołu SSL albo nie

parametry

  • wartość - jeśli 1 wszystkie żądania do API GrabzIt będą używać SSL
    • wymagany

Klasy wyników

GrabzItCookie

Metody publiczne

  • getName ()
    • Nazwa ciasteczka
  • getValue ()
    • Wartość pliku cookie.
  • getDomain ()
    • Domena, dla której ustawiony jest plik cookie.
  • getPath ()
    • Ścieżka do domeny, której dotyczy ten plik cookie.
  • getHttpOnly ()
    • Jeśli ten plik cookie jest ważny tylko wtedy, gdy witryna jest przeglądana za pomocą protokołu HTTP.
  • getExpires ()
    • Data wygaśnięcia tego pliku cookie
  • getType ()
    • Jest to rodzaj pliku cookie, który może być jednym z następujących:
      • Globalny - jest to globalny plik cookie ustawiony przez GrabzIt
      • Lokalny - to lokalny plik cookie ustawiony przez Ciebie
      • Zastąpione - globalne ciasteczko, które zostało przez Ciebie zastąpione

GrabzItStatus

Klasa reprezentująca bieżący status zrzutu ekranu.

Metody publiczne

  • getProcessing ()
    • Jeśli 1 zrzut ekranu jest nadal przetwarzany.
  • getCached ()
    • Jeśli 1 zrzut ekranu został przetworzony i jest obecnie buforowany.
  • getExpired ()
    • Jeśli 1 zrzut ekranu nie jest już dostępny w systemie GrabzIt.
  • getMessage ()
    • Komunikat o błędzie zwrócony przez system.

GrabzItWaterMark

Ta klasa reprezentuje niestandardowe znaki wodne przechowywane w GrabzIt

Metody publiczne

  • getIdentifier ()
    • Identyfikator znaku wodnego
  • getXPosition ()
    • Pozioma pozycja znaku wodnego
      • Lewy = 0
      • Centrum = 1
      • Prawo = 2
  • getYPosition ()
    • Pionowa pozycja znaku wodnego
      • Góra = 0
      • Middle = 1
      • Dół = 2
  • getFormat ()
    • Format znaku wodnego