GrabzItClient z Javą

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)

GrabzItFile GetResult(String 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

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.
  • 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 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.
  • Domyślnie: pusty
• 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.
  • Domyślnie: 0 sekund
• 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
• setReverse(boolean value) - jeśli to prawda, ramki animowanego GIF-a są odwrócone
  • Domyślnie: false
• setCustomWaterMarkId(String value) - dodaj niestandardowy znak wodny do animowanego GIF-a
  • Domyślnie: pusty
• 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.
  • 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: 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
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty

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
  • wymagany
• 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
  • wymagany
• 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
  • wymagany
• 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.
  • Domyślnie: pusty
• setBrowserWidth(int value) - szerokość przeglądarki w pikselach
  • Domyślnie: 1024
  • Maksymalna ilość znaków: 10000
• setBrowserHeight(int 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)
• setWidth(int 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)
• setHeight(int 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)
• setFormat(ImageFormat value) - format, w jakim powinien być zrzut ekranu.
  • Zaniedbanie: ImageFormat. JPG
  • Opcje: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormat.BMP, ImageFormat.SPRZECZKA, ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
  • Domyślnie: 0
  • Maksymalna ilość znaków: 30000
• setTargetElement(String 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
• setHideElement(String 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
• setWaitForElement(String value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
  • Domyślnie: pusty
• setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
  • Zaniedbanie: BrowserType.STANDARDBROWSER
  • Opcje: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.WYSZUKIWARKA, BrowserType.FALLBACKBROWSER
• setCustomWaterMarkId(String value) - dodaj niestandardowy znak wodny do obrazu
  • Domyślnie: pusty
• setQuality(int 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
• setTransparent(boolean value) - jeśli to prawda przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
  • Domyślnie: false
• setHd(boolean value) - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
  • Domyślnie: false
• setCountry(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: 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
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
  • Domyślnie: false
• setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
  • Domyślnie: false
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty

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
  • wymagany
• 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
  • wymagany
• 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

• 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.
  • Domyślnie: pusty
• setBrowserWidth(int value) - szerokość przeglądarki w pikselach
  • Domyślnie: 1024
  • Maksymalna ilość znaków: 10000
• setBrowserHeight(int value) - wysokość przeglądarki w pikselach
  • Domyślnie: 768
  • Maksymalna ilość znaków: 10000
• setWaitForElement(String value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
  • Domyślnie: pusty
• setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
  • Zaniedbanie: BrowserType.STANDARDBROWSER
  • Opcje: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.WYSZUKIWARKA, BrowserType.FALLBACKBROWSER
• setExportURL(String value) - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
  • Domyślnie: false
• setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
  • Domyślnie: false
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty

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
  • wymagany
• 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
  • wymagany
• 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
  • wymagany
• 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.
  • Domyślnie: pusty
• setIncludeBackground(boolean value) - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
  • Domyślnie: true
• setPageSize(PageSize value) - rozmiar strony pliku PDF
  • Zaniedbanie: PageSize.A4
  • Opcje: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.PRAWNY, PageSize.LIST
• setOrientation(PageOrientation value) - orientacja dokumentu PDF
  • Zaniedbanie: PageOrientation.PORTRET
  • Opcje: PageOrientation.PORTRET, PageOrientation.KRAJOBRAZ
• setCSSMediaType(CSSMediaType value) - w CSS Media Typ dokumentu PDF
  • Zaniedbanie: CSSMediaType.EKRAN
  • Opcje: CSSMediaType.EKRAN, CSSMediaType.WYDRUKOWAĆ
• setIncludeLinks(boolean value) - prawda, jeśli linki powinny być zawarte w pliku PDF
  • Domyślnie: true
• setIncludeOutline(boolean value) - prawda, jeśli Zakładki PDF powinno być dołączone
  • Domyślnie: false
• setTitle(String value) - podać tytuł dokumentu PDF
  • Domyślnie: pusty
• setCoverURL(string value) - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
  • Domyślnie: pusty
• setMarginTop(int value) - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
  • Domyślnie: 10
• setMarginLeft(int value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
  • Domyślnie: 10
• setMarginBottom(int value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
  • Domyślnie: 10
• setMarginRight(int value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
  • Domyślnie: 10
• 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: 1024
  • 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ć
  • Zaniedbanie: BrowserType.STANDARDBROWSER
  • Opcje: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.WYSZUKIWARKA, BrowserType.FALLBACKBROWSER
• setTemplateId(String value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
  • Domyślnie: pusty
• setTargetElement(String value) - identyfikator lub klasa 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
  • Domyślnie: pusty
• setHideElement(String 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
• setWaitForElement(String value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
  • Domyślnie: pusty
• setCustomWaterMarkId(String value) - dodaj niestandardowy znak wodny do każdej strony dokumentu PDF
  • Domyślnie: pusty
• 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.
  • 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: 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
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
  • Domyślnie: false
• setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
  • Domyślnie: false
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty
• setMergeId(String mergeId) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
  • Domyślnie: pusty
• setPassword(String password) - w hasło do ochrony dokumentu PDF z
  • Domyślnie: pusty

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
  • wymagany
• 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
  • wymagany
• 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
  • wymagany
• 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.
  • Domyślnie: pusty
• setIncludeBackground(boolean value) - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
  • Domyślnie: true
• setPageSize(PageSize value) - rozmiar strony DOCX
  • Zaniedbanie: PageSize.A4
  • Opcje: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.PRAWNY, PageSize.LIST
• setOrientation(PageOrientation value) - orientacja dokumentu DOCX
  • Zaniedbanie: PageOrientation.PORTRET
  • Opcje: PageOrientation.PORTRET, PageOrientation.KRAJOBRAZ
• setIncludeLinks(boolean value) - prawda, jeśli linki powinny być zawarte w DOCX
  • Domyślnie: true
• setIncludeImages(boolean value) - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
  • Domyślnie: true
• setTitle(String value) - podać tytuł dokumentu DOCX
  • Domyślnie: pusty
• setMarginTop(int value) - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
  • Domyślnie: 10
• setMarginLeft(int value) - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
  • Domyślnie: 10
• setMarginBottom(int value) - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
  • Domyślnie: 10
• setMarginRight(int value) - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
  • Domyślnie: 10
• 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: 1024
  • 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ć
  • Zaniedbanie: BrowserType.STANDARDBROWSER
  • Opcje: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.WYSZUKIWARKA, BrowserType.FALLBACKBROWSER
• setTemplateId(String value) - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
  • Domyślnie: pusty
• setTargetElement(String 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
• setHideElement(String 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
• setWaitForElement(String value) - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
  • Domyślnie: pusty
• 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.
  • 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: 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
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setNoAds(boolean noAds) - Jeśli prawda reklamy powinny być automatycznie ukryte.
  • Domyślnie: false
• setNoCookieNotifications(boolean noCookieNotifications) - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
  • Domyślnie: false
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty
• setMergeId(String mergeId) - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
  • Domyślnie: pusty
• setPassword(String mergeId) - w hasło do ochrony dokumentu DOCX z
  • Domyślnie: pusty

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
  • wymagany
• 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.
  • wymagany
• 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.
  • wymagany
• 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
  • Domyślnie: pusty
• 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
  • Domyślnie: 1
• setFormat(TableFormat value) - format, w jakim powinna być tabela
  • Zaniedbanie: TableFormat.CSV
  • Opcje: TableFormat.CSV, TableFormat.JSON, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
  • Domyślnie: true
• 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
  • Domyślnie: false
• setTargetElement(String value) - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
  • Domyślnie: pusty
• setRequestAs(BrowserType value) - rodzaj agenta użytkownika, którego chcesz używać
  • Zaniedbanie: BrowserType.STANDARDBROWSER
  • Opcje: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.WYSZUKIWARKA, BrowserType.FALLBACKBROWSER
• setCountry(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: 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
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• 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.
  • Domyślnie: pusty
• setProxy(String proxy) - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
  • Domyślnie: pusty

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

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
  • wymagany

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

GrabzItFile SaveTo()

Save wynik synchronicznie do GrabzItFile obiekt.

Wartość zwracana

GrabzItFile przedmiot

SaveTo(String saveDo pliku)

Save wynik synchronicznie do pliku.

parametry

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

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
  • wymagany

Wartość zwracana

status przedmiot

GrabzItCookie [] GetCookies (String domena)

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 (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ć
  • 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 - 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
  • wymagany
• domena - domena strony internetowej, dla której chcesz usunąć plik cookie
  • wymagany

Wartość zwracana

Prawda, jeśli plik cookie zostanie pomyślnie usunięty, w przeciwnym razie fałsz

WaterMark[] OtrzymaćWaterMarks()

Uzyskaj wszystkie przesłane niestandardowe znaki wodne

Wartość zwracana

WaterMark szyk

WaterMark OtrzymaćWaterMark(String 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

WaterMark przedmiot

dodaćWaterMark(String identyfikator, String ścieżka, HorizontalPosition XP, VerticalPosition 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: HorizontalPosition.LEWO, HorizontalPosition.ŚRODEK, HorizontalPosition.DOBRZE
• ypos - pozycja pionowa, w której ma się pojawić zrzut ekranu
  • wymagany
  • Opcje: VerticalPosition.TOP, VerticalPosition.ŚRODKOWY, VerticalPosition.DOLNY

Wartość zwracana

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

DeleteWaterMark(String identyfikator)

Usuń niestandardowy znak wodny

parametry

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

Wartość zwracana

zwraca true, jeśli znak wodny 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
  • wymagany

UseSSL (boolwartość ean)

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
  • wymagany

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

• ścieżka - ścieżka zaszyfrowanego przechwytywania
  • wymagany
• klucz - klucz szyfrujący
  • wymagany

GrabzItFile Odszyfruj (GrabzItFile file, String klawisz)

Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.

parametry

• plik - zaszyfrowany GrabzItFile
  • wymagany
• klucz - klucz szyfrujący
  • wymagany

byte [] Deszyfruj (byte [] dane, String klawisz)

Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.

parametry

• dane - zaszyfrowane bajty
  • wymagany
• klucz - klucz szyfrujący
  • wymagany

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
• PRZEGLĄDARKA PRZEGLĄDAREK

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.

• KRAJOBRAZ
• PORTRET

CSSMediaType

Ten wyliczenie obejmuje następujące wartości.

• WYDRUKOWAĆ
• EKRAN

TableFormat

Ten wyliczenie obejmuje następujące wartości.

• CSV
• JSON
• XSLX

HorizontalPosition

Ten wyliczenie obejmuje następujące wartości.

• LEWA
• CENTRUM
• PRAWO

VerticalPosition

Ten wyliczenie obejmuje następujące wartości.

• TOP
• ŚRODKOWY
• DOLNY

Klasy wyników

ciastko

Właściwości publiczne

• String getName()
  • Nazwa ciasteczka
• String getValue()
  • Wartość pliku cookie.
• 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 isExpired ()
  • 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 znaki wodne przechowywane w GrabzIt

Metody publiczne

• String getIdentifier ()
• String getFormat ()
• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()