Opis
Ta klasa obsługuje całą komunikację z usługami zrzutów ekranu GrabzIt.
Metody publiczne
- 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)
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
Wartość zwracana
GrabzItFile przedmiot
URLToAnimation(String adres URL, AnimationOptions 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.
- Wymagane
-
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 AnimationOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia animowanego GIF-a.
Wartość zwracana
unieważnić
AnimationOptions
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia animowanego GIF-a.
Właściwości publiczne
-
setCustomId(String 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.
-
setWidth(int 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)
-
setHeight(int 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)
-
setStart(int value) - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
-
setDuration(int value) - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: maksymalna długość paczki
-
setSpeed(float value) - prędkość animowanego GIF-a.
- Domyślnie: 1
- Minimum: 0.2
- Maksymalna ilość znaków: 10
-
setFramesPerSecond(float value) - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
- Domyślnie: 10
- Minimum: 0.2
- Maksymalna ilość znaków: 60
-
setRepeat(int value) - ile razy zapętlono animowany GIF.
- Domyślnie: 0
- Pętla w sposób ciągły: 0
- Nigdy nie pętla: -1
-
setReverse(boolean value) - jeśli to prawda, ramki animowanego GIF-a są odwrócone
-
setCustomWaterMarkId(String value) - dodaj niestandardowe watermark do animowanego GIF-a
-
setQuality(int 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
-
setCountry(Country value) - kraj animowany GIF powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.SINGAPUR, Kraj.ZJEDNOCZONE KRÓLESTWO, Kraj.STANY ZJEDNOCZONE
-
setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
setEncryptionKey(String key) - jeśli określono podstawowy klucz szyfrowania AES 64, 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.
-
setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
URLToImage(String adres URL, ImageOptions 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
- Opcje - instancja ImageOptions klasa, która definiuje specjalne opcje do użycia podczas tworzenia zrzutu ekranu.
Wartość zwracana
unieważnić
HTMLToImage(String HTML, ImageOptions opcje)
Określa kod HTML, który należy przekonwertować into obrazie.
parametry
-
HTML - kod HTML do konwersji into obrazie
- Opcje - instancja ImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.
Wartość zwracana
unieważnić
FileToImage(String ścieżka, ImageOptions opcje)
Określa plik HTML, który należy przekonwertować into obrazie.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into obrazie
- Opcje - instancja ImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.
Wartość zwracana
unieważnić
ImageOptions
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów obrazu.
Właściwości publiczne
-
setCustomId(String 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.
-
setBrowserWidth(int value) - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
-
setBrowserHeight(int value) - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
- Pełna długość: -1 (przekazanie -1 oznacza, że wykonano sceenshot całej strony)
-
setOutputWidth(int value) - szerokość wynikowej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono wysokość wyjściową, szerokość wyjściowa będzie proporcjonalna do wysokości wyjściowej
- Maksymalna: maksymalna szerokość paczki
- Pełna szerokość: -1 (przekazanie -1 oznacza, że szerokość miniatury nie jest zmniejszona)
-
setOutputHeight(int value) - wysokość powstałej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono szerokość wyjściową, wysokość wyjściowa będzie proporcjonalna do szerokości wyjściowej
- Maksymalna: maksymalna wysokość paczki
- Pełna wysokość: -1 (przekazanie -1 oznacza, że wysokość miniatury nie jest zmniejszona)
-
setFormat(ImageFormat value) - format, w jakim powinien być zrzut ekranu.
-
setDelay(int value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
setClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
setTargetElement(String value) - w 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
-
setHideElement(String value) - w 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
-
setWaitForElement(String value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
-
setCustomWaterMarkId(String value) - dodaj niestandardowy watermark do obrazu
-
setQuality(int value) - w jakość zwróconego obrazu. Obecnie wpływa to tylko na obrazy JPG i WEBP, które mają domyślną kompresję 90%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
-
setTransparent(boolean value) - jeśli to prawda przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
-
setHd(boolean value) - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
-
setCountry(Country value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.SINGAPUR, Kraj.ZJEDNOCZONE KRÓLESTWO, Kraj.STANY ZJEDNOCZONE
-
setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
setEncryptionKey(String key) - jeśli określono podstawowy klucz szyfrowania AES 64, 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.
-
setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
setAddress(String address) - 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.
-
setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
Metody publiczne
-
AddPostParameter (String imię, String 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(String adres URL, HTMLOptions opcje)
Określa adres URL, który należy przekonwertować into renderowany HTML.
parametry
-
url - adres URL, z którego powinien być wykonany renderowany HTML
-
Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
Wartość zwracana
unieważnić
HTMLToRenderedHTML(string HTML, HTMLOptions opcje)
Określa kod HTML, który należy przekonwertować into renderowany HTML.
parametry
-
HTML - kod HTML do konwersji into renderowany HTML
- Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
Wartość zwracana
unieważnić
FileToRenderedHTML(string ścieżka, HTMLOptions opcje)
Określa plik HTML, który należy przekonwertować into renderowany HTML.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into renderowany HTML
-
Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
Wartość zwracana
unieważnić
HTMLOptions
Klasa reprezentuje wszystkie opcje dostępne, kiedy tworzenie renderowanych zrzutów HTML.
Właściwości publiczne
Metody publiczne
-
AddPostParameter (String imię, String 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(String adres URL, PDFOpcje opcje)
Określa adres URL, który należy przekonwertować into PDF.
parametry
-
url - adres URL, który należy przekonwertować into PDF
- PDFOpcje options - instancja klasy PDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
Wartość zwracana
unieważnić
HTMLToPDF(String HTML, PDFOpcje opcje)
Określa kod HTML, który należy przekonwertować into PDF.
parametry
-
HTML - kod HTML do konwersji into PDF
- PDFOpcje options - instancja klasy PDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
Wartość zwracana
unieważnić
FileToPDF(String ścieżka, PDFOpcje opcje)
Określa plik HTML, który należy przekonwertować into PDF.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into PDF
- PDFOpcje options - instancja klasy PDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
Wartość zwracana
unieważnić
PDFOpcje
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów PDF.
Właściwości publiczne
-
setCustomId(String value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
setIncludeBackground(boolean value) - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
-
setPageSize(PageSize value) - rozmiar strony pliku PDF
-
setOrientation(PageOrientation value) - orientacja dokumentu PDF
-
setCSSMediaType(CSSMediaType value) - w CSS Media Typ dokumentu PDF
-
setIncludeLinks(boolean value) - prawda, jeśli linki powinny być zawarte w pliku PDF
-
setIncludeOutline(boolean value) - prawda, jeśli Zakładki PDF powinno być dołączone
-
setTitle(String value) - podać tytuł dokumentu PDF
-
setCoverURL(string value) - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
-
setMarginTop(int value) - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
-
setMarginLeft(int value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
-
setMarginBottom(int value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
-
setMarginRight(int value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
-
setBrowserWidth(int value) - the 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: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu PDF)
-
setPageWidth(int value) - w niestandardowa szerokość wynikowego pliku PDF w mm
- Zaniedbanie: PageSize szerokość
- Minimum: 15
-
setPageHeight(int value) - w niestandardowa wysokość wynikowego pliku PDF w mm
- Zaniedbanie: PageSize wysokość
- Minimum: 15
-
setDelay(int value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
-
setTemplateId(String value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
-
setClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
setTargetElement(String value) - w Selektor CSS jedyny Element HTML na docelowej stronie internetowej, która ma zostać odwrócona into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
-
setHideElement(String value) - w 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
-
setWaitForElement(String value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
setCustomWaterMarkId(String value) - dodaj niestandardowy watermark na każdej stronie dokumentu PDF
-
setQuality(int 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
-
setCountry(Country value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.SINGAPUR, Kraj.ZJEDNOCZONE KRÓLESTWO, Kraj.STANY ZJEDNOCZONE
-
setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
setEncryptionKey(String key) - jeśli określono podstawowy klucz szyfrowania AES 64, 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.
-
setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
setAddress(String address) - 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.
-
setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
-
setMergeId(String mergeId) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
-
setPassword(String password) - w hasło do ochrony dokumentu PDF z
Metody publiczne
-
AddPostParameter (String imię, String 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 (String imię, String 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 (String adres URL, DOCXOptions opcje)
Określa adres URL, który należy przekonwertować into DOCX.
parametry
-
url - adres URL, który należy przekonwertować into DOCX
- DOCXOptions opcje - instancja DOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
Wartość zwracana
unieważnić
HTMLToDOCX(String HTML, DOCXOptions opcje)
Określa kod HTML, który należy przekonwertować into DOCX.
parametry
-
HTML - kod HTML do konwersji into DOCX
- DOCXOptions opcje - instancja DOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
Wartość zwracana
unieważnić
FileToDOCX(String ścieżka, DOCXOptions opcje)
Określa plik HTML, który należy przekonwertować into DOCX.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into DOCX
- DOCXOptions opcje - instancja DOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
Wartość zwracana
unieważnić
DOCXOptions
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia przechwytywania DOCX.
Właściwości publiczne
-
setCustomId(String value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
setIncludeBackground(boolean value) - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
-
setPageSize(PageSize value) - rozmiar strony DOCX
-
setOrientation(PageOrientation value) - orientacja dokumentu DOCX
-
setIncludeLinks(boolean value) - prawda, jeśli linki powinny być zawarte w DOCX
-
setIncludeImages(boolean value) - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
-
setTitle(String value) - podać tytuł dokumentu DOCX
-
setMarginTop(int value) - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
-
setMarginLeft(int value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
-
setMarginBottom(int value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
-
setMarginRight(int value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
-
setBrowserWidth(int 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: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu PDF)
-
setPageWidth(int value) - w niestandardowa szerokość wynikowego DOCX w mm
- Zaniedbanie: PageSize szerokość
- Minimum: 15
-
setPageHeight(int value) - w niestandardowa wysokość wynikowego DOCX w mm
- Zaniedbanie: PageSize wysokość
- Minimum: 15
-
setDelay(int value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
-
setTemplateId(String value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
-
setClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
setTargetElement(String value) - w 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
-
setHideElement(String value) - w 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
-
setWaitForElement(String value) - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
setQuality(int 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
-
setCountry(Country value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.SINGAPUR, Kraj.ZJEDNOCZONE KRÓLESTWO, Kraj.STANY ZJEDNOCZONE
-
setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
setEncryptionKey(String key) - jeśli określono podstawowy klucz szyfrowania AES 64, 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.
-
setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
setAddress(String address) - 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.
-
setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
-
setMergeId(String mergeId) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
-
setPassword(String mergeId) - w hasło do ochrony dokumentu DOCX z
Metody publiczne
-
AddPostParameter (String imię, String 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 (String imię, String 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(String adres URL, TableOptions opcje)
Określa adres URL, z którego należy wyodrębnić tabele HTML.
parametry
-
url - adres URL do wyodrębnienia tabel HTML
- TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
Wartość zwracana
unieważnić
HTMLToTable (String HTML, TableOptions 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.
- TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
Wartość zwracana
unieważnić
FileToTable (String ścieżka, TableOptions 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.
- TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
Wartość zwracana
unieważnić
TableOptions
Klasa reprezentuje wszystkie opcje dostępne podczas konwersji tabel HTML na CSV, XLSX lub JSON.
Właściwości publiczne
-
setCustomId(String value) - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego
-
setTableNumberToInclude(int value) - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
-
setFormat(TableFormat value) - format, w jakim powinna być tabela
-
setIncludeHeaderNames(boolean value) - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
-
setIncludeAllTables(boolean value) - jeśli to prawda, wszystkie tabele na stronie internetowej zostaną wyodrębnione, a każdy z nich pojawi się w osobnym arkuszu kalkulacyjnym. Dostępne tylko w formacie XLSX
-
setTargetElement(String value) - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
-
setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
-
setCountry(Country value) - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.SINGAPUR, Kraj.ZJEDNOCZONE KRÓLESTWO, Kraj.STANY ZJEDNOCZONE
-
setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
setEncryptionKey(String key) - jeśli określono podstawowy klucz szyfrowania AES 64, 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.
-
setAddress(String address) - 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.
-
setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
Metody publiczne
-
AddPostParameter (String imię, String 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
Save()
Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z GetResult Metoda.
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
Jest to zalecana metoda zapisywania pliku
Save(String 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
Save wynik synchronicznie do GrabzItFile obiekt.
Wartość zwracana
GrabzItFile przedmiot
Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku
SaveTo(String saveToPlik)
Save wynik synchronicznie do pliku.
parametry
-
saveToPlik - ścieżka do pliku, który będzie przechwytywany saved po zakończeniu
Wartość zwracana
zwraca prawdę, jeśli się powiedzie, w przeciwnym razie zgłasza wyjątek.
status GetStatus (String ID)
Uzyskaj aktualny status zrzutu ekranu GrabzIt.
parametry
-
id - unikalny identyfikator zrzutu ekranu
Wartość zwracana
status przedmiot
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
Wartość zwracana
GrabzItCookie szyk
SetCookie (String imię, String domena, String wartość, String ścieżka, boolean httponly, data wygasa)
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ć
-
domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
- wartość - wartość pliku cookie
- ścieżka - ścieżka do strony, której dotyczy plik cookie
- httponly - jeśli to prawda, 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
Wartość zwracana
Prawda, jeśli plik cookie został pomyślnie ustawiony, w przeciwnym razie fałsz
DeleteCookie (String imię, String domena)
Usuń niestandardowy plik cookie lub zablokuj używanie globalnego pliku cookie
parametry
-
nazwa - nazwa pliku cookie do usunięcia
-
domena - domena strony internetowej, dla której chcesz usunąć plik cookie
Wartość zwracana
Prawda, jeśli plik cookie zostanie pomyślnie usunięty, w przeciwnym razie fałsz
Pobierz wszystkie przesłane pliki niestandardowe watermarks
Wartość zwracana
WaterMark szyk
WaterMark Get WaterMark(String identyfikator)
Zwróć swoje zamówienie watermarks który pasuje do określonego identyfikatora
parametry
-
identyfikator - identyfikator konkretnego zwyczaju watermark chcesz zobaczyć
Wartość zwracana
WaterMark przedmiot
Dodaj nowy zwyczaj watermark
parametry
-
identyfikator - identyfikator, który chcesz nadać niestandardowemu watermark. Ważne jest, aby ten identyfikator był niepowtarzalny.
-
path - bezwzględna ścieżka pliku watermark na twoim serwerze. Na przykład C: /watermark/1.png
-
xpos - pozycja pozioma, na której ma się pojawić zrzut ekranu
-
ypos - pozycja pionowa, w której ma się pojawić zrzut ekranu
Wartość zwracana
zwraca prawdę, jeśli watermark został pomyślnie ustawiony
DeleteWaterMark(String identyfikator)
Usuń niestandardowy watermark
parametry
-
identyfikator - identyfikator zwyczaju watermark chcesz usunąć
Wartość zwracana
zwraca prawdę, jeśli watermark został pomyślnie usunięty
SetLocalProxy (String proxyUrl)
Ta metoda umożliwia lokalny serwer proxy do wykorzystania we wszystkich żądaniach.
parametry
-
proxyUrl - adres URL, który w razie potrzeby może zawierać port serwera proxy. Podanie wartości null spowoduje usunięcie wcześniej ustawionego serwera proxy
UseSSL (boolean wartość)
Określa, czy żądania do GrabzIt's Interfejs API powinien używać protokołu SSL
parametry
-
wartość - jeśli ma wartość true, wszystkie żądania do interfejsu API GrabzIt będą używać protokołu SSL
String CreateEncryptionKey ()
Utwórz kryptograficznie bezpieczny podstawowy klucz szyfrowania 64 o długości znaków 44.
Odszyfruj (String ścieżka, String klawisz)
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
GrabzItFile Odszyfruj (GrabzItFile file, String klawisz)
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
byte [] Deszyfruj (byte [] dane, String klawisz)
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
Enums
ImageFormat
Ten wyliczenie obejmuje następujące wartości.
- BMP8
- BMP16
- BMP24
- BMP
- JPG
- TIFF
- PNG
- WEBP
BrowserType
Ten wyliczenie obejmuje następujące wartości.
- PRZEGLĄDARKA STANDARDÓW
- PRZEGLĄDARKA MOBILNA
- WYSZUKIWARKA
Kraj
Ten wyliczenie obejmuje następujące wartości.
- DEFAULT
- SINGAPUR
- ZJEDNOCZONE KRÓLESTWO
- STANY ZJEDNOCZONE
PageSize
Ten wyliczenie obejmuje następujące wartości.
- A3
- A4
- A5
- A6
- B3
- B4
- B5
- B6
- Prawne
- LIST
PageOrientation
Ten wyliczenie obejmuje następujące wartości.
CSSMediaType
Ten wyliczenie obejmuje następujące wartości.
TableFormat
Ten wyliczenie obejmuje następujące wartości.
HorizontalPosition
Ten wyliczenie obejmuje następujące wartości.
VerticalPosition
Ten wyliczenie obejmuje następujące wartości.
Klasy wyników
Cookies
Właściwości publiczne
-
String getName()
-
String getValue()
-
String getDomain()
- Domena, dla której ustawiony jest plik cookie.
-
String getPath()
- Ścieżka do domeny, której dotyczy ten plik cookie.
-
String getHttpOnly()
- Jeśli ten plik cookie jest ważny tylko wtedy, gdy witryna jest przeglądana za pomocą protokołu HTTP.
-
String getExpires()
- Data wygaśnięcia tego pliku cookie
-
String 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
GrabzItFile
Metody publiczne
- byte [] getBytes ()
- unieważnić Save(String ścieżka)
- String doString()
status
Klasa reprezentująca bieżący status zrzutu ekranu.
Metody publiczne
-
boolean isProcessing ()
- Jeśli true, zrzut ekranu jest nadal przetwarzany.
-
boolean isCached ()
- Jeśli true, zrzut ekranu został przetworzony i jest obecnie buforowany.
-
boolean straciła ważność()
- Jeśli to prawda, zrzut ekranu nie jest już dostępny w systemie GrabzIt.
-
String getMessage ()
- Komunikat o błędzie zwrócony przez system.
WaterMark
Ta klasa reprezentuje niestandardowe watermarks przechowywane w GrabzIt
Metody publiczne