Ta strona zawiera listę klas, metod i wyliczonych typów dostępnych w interfejsie Google Picker API. Wszystkie te elementy należą do przestrzeni nazw google.picker.*Istnieją 2 typy klas i wyliczonych typów: te, które służą do tworzenia i konfigurowania selektora Google, oraz te, które są zwracane przez selektor Google po wybraniu elementu przez użytkownika.
Klasy i typy konfiguracji
Poniższe klasy i wyliczane typy są używane do tworzenia i konfigurowania selektora Google.
DokumentyUploadView
Użyj DocsUploadView, aby przesłać dokumenty na Dysk Google.
DocsUploadView() | Konstruktor. |
DocsUploadView.setIncludeFolders(boolean) | Pozwala użytkownikowi wybrać folder na Dysku Google, do którego chce przesłać pliki. |
DocsUploadView.setParent(string) | Ustawia miejsce docelowe przesyłania na określony folder. Spowoduje to zastąpienie wartości setIncludeFolders wartością false (fałsz). |
Widok dokumentów
DocsView to podklasa View, której można używać w widokach Dysku Google.
DocsView(ViewId | undefined) | Konstruktor. ViewId musi być jednym z widoków Dysku Google. Wartość domyślna to ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Pokazuje dyski współdzielone i znajdujące się w nich pliki. Zanim włączysz tę funkcję, zapoznaj się z dokumentacją interfejsu API Dysku Google dotyczącą włączania dysków współdzielonych. |
DocsView.setIncludeFolders(boolean) | Pokazuj foldery w elementach widoku danych. Nie łącz z usługą setOwnedByMe. Jeśli zasada setIncludeFolders(true) jest skonfigurowana, setOwnedByMe jest ignorowany. |
DocsView.setSelectFolderEnabled(boolean) | Pozwala użytkownikowi wybrać folder na Dysku Google. |
DocsView.setMode(DocsViewMode) | Określa tryb wyświetlania dokumentów w widoku. |
DocsView.setOwnedByMe(boolean | undefined) | Filtruje dokumenty na podstawie tego, czy są własnością użytkownika lub zostały mu udostępnione. Nie łącz tego ustawienia z zasadą setIncludeFolders. Jeśli zasada setIncludeFolders(true) jest skonfigurowana, setOwnedByMe jest ignorowany. |
DocsView.setParent(string) | Ustawia wyświetlany początkowy folder nadrzędny. |
DocsView.setStarred(boolean) | Filtruje dokumenty na podstawie tego, czy użytkownik je oznaczył. |
Tryb widoku Dokumentów
DocsViewMode to wyliczony typ wyświetlania danych w widoku Dokumentów. Użyj tych wartości w wywołaniach DocsView.setMode.
DocsViewMode.GRID | Wyświetlaj dokumenty w siatce miniatur. |
DocsViewMode.LIST | Wyświetl dokumenty na szczegółowej liście. |
Funkcja
Feature to wyliczony typ służący do włączania i wyłączania funkcji w różnych widokach. Użyj tych wartości w wywołaniach PickerBuilder.enableFeature i PickerBuilder.disableFeature.
Feature.MINE_ONLY | Pokazuj tylko dokumenty należące do użytkownika podczas wyświetlania elementów z Dysku Google. |
Feature.MULTISELECT_ENABLED | Zezwalaj użytkownikom na wybieranie więcej niż 1 elementu. |
Feature.NAV_HIDDEN | Ukryj panel użytkownika. Jeśli panel nawigacyjny jest ukryty, użytkownicy mogą wybierać tylko spośród pierwszego wybranego widoku. |
Feature.SIMPLE_UPLOAD_ENABLED | W przypadku przesyłania zdjęć określa, czy wybór poszczególnych zdjęć (w odróżnieniu od albumów) jest włączony. |
Feature.SUPPORT_DRIVES |
Wycofane: elementy na dysku współdzielonym są teraz domyślnie dostępne. Określa, czy elementy z dysku współdzielonego są uwzględniane w wynikach. |
Selektor
Picker to obiekt najwyższego poziomu reprezentujący działanie użytkownika w interfejsie. Takie obiekty nie są tworzone bezpośrednio, tylko korzystają z obiektu PickerBuilder.
Picker.isVisible() | Wartość logiczna wskazuje aktualną widoczność selektora. |
Picker.setCallback(function(object)) | Określ metodę wywołania zwrotnego zawsze wtedy, gdy użytkownik wybierze element (lub go anuluje). |
Picker.setRelayUrl(string) | Podaj adres URL usługi przekaźnika, aby obejść problemy z wieloma domenami. |
Picker.setVisible(boolean) | Kontroluje widoczność obiektu selektora. |
Picker.dispose() | Usuwa obiekt selektora. |
Selektor kompilacji
PickerBuilder jest używany do tworzenia obiektów Picker. O ile nie zaznaczono inaczej, poniższe metody zwracania są typu PickerBuilder, co pozwala łączyć je w poszczególne wywołania. Typowe zastosowanie znajdziesz w przykładowym kodzie Google Picker.
PickerBuilder() | Konstruktor. |
PickerBuilder.addView( | Dodaj View do panelu nawigacji. |
PickerBuilder.addViewGroup(ViewGroup) | Dodaj ViewGroup do panelu nawigacyjnego najwyższego poziomu. |
PickerBuilder.build() | Utwórz obiekt usługi Picker. Zostanie zwrócony obiekt selektora. |
PickerBuilder.disableFeature(Feature) | Wyłącz funkcję selektora. |
PickerBuilder.enableFeature(Feature) | Włącz funkcję selektora. |
PickerBuilder.getRelayUrl() | Pobierz adres URL usługi przekaźnika, wykorzystywany na potrzeby pliku Gadgets.rpc. |
PickerBuilder.getTitle() | Pobierz tytuł okna dialogowego. |
PickerBuilder.hideTitleBar() | Wyłącz wyświetlanie paska tytułu. Aby ponownie włączyć tę funkcję, wywołaj funkcję setTitle z niepustym tytułem lub niezdefiniowanym. |
PickerBuilder.isFeatureEnabled(Feature) | Sprawdź, czy selektor Feature jest włączony. |
PickerBuilder.setAppId(string) | Określa identyfikator aplikacji Dysku Google wymagany, aby aplikacja mogła korzystać z plików użytkownika za pomocą interfejsu Google Drive API. |
PickerBuilder.setCallback(method) | Ustaw metodę wywołania zwrotnego. Ta metoda jest wywoływana, gdy użytkownik wybierze lub anuluje zakup. Metoda wywołania zwrotnego otrzymuje pojedynczy obiekt wywołania zwrotnego. Strukturę obiektu wywołania zwrotnego opisano w przewodniku po JSON. |
PickerBuilder.setDeveloperKey(string) | Ustawia klucz interfejsu API przeglądarki uzyskany z konsoli interfejsu API Google. Szczegółowe informacje o tym, jak uzyskać klucz Browser API, znajdziesz w przewodniku dla programistów. |
PickerBuilder.setDocument(document) | Ustaw dokument. |
PickerBuilder.setLocale(string) | Kod języka w formacie ISO 639. Jeśli język nie jest obsługiwany, używany jest język en-US. Ta metoda stanowi alternatywę dla ustawień regionalnych google.load(). Listę obsługiwanych języków znajdziesz w przewodniku dla programistów. |
PickerBuilder.setMaxItems(number) | Określa maksymalną liczbę elementów, które użytkownik może wybrać. |
PickerBuilder.setOAuthToken(string) | Ustawia token OAuth używany do uwierzytelniania bieżącego użytkownika. W zależności od zakresu tokena tylko dane są wyświetlane. Prawidłowe zakresy to Dokumenty Google, Dysk, Zdjęcia, YouTube. |
PickerBuilder.setOrigin(string) | Ustawia początek okna wyboru Google. Jeśli aplikacja działa w elemencie iframe, powinien zostać ustawiony na window.location.protocol + '//' + window.location.host strony najwyższego poziomu. |
PickerBuilder.setRelayUrl(string) | Ustaw adres URL usługi przekaźnika, który jest używany w domenie Gadgets.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Ustaw listę możliwych do wyboru typów MIME. Jeśli wymagane są więcej typów MIME, rozdziel je przecinkami. |
PickerBuilder.setSize() | Ustaw preferowany rozmiar okna. Okno jest automatycznie wyśrodkowane. Minimalny rozmiar to 566 350, a maksymalny – 1051 650. |
PickerBuilder.setTitle(string) | Ustaw tytuł okna. |
PickerBuilder.toUri() | Zwraca identyfikator URI wygenerowany przez ten konstruktor. |
Identyfikator zasobu
ResourceId to klasa statyczna, która służy do generowania identyfikatorów zasobów odpowiednich dla interfejsu API Dokumentów Google.
ResourceId.generate(Document) | Zmapuj obiekt dokumentu na identyfikator zasobu. |
Wyświetl
View to abstrakcyjna klasa podstawowa dla różnych klas widoku, takich jak DocsView.
View(ViewId) | Konstruktor. |
View.getId() | Zwraca wartość ViewId dla tego widoku. |
View.setMimeTypes(string) | Ustawia typy MIME w widoku danych. Jeśli wymagane są więcej typów MIME, rozdziel je przecinkami. Jeśli nie ustawisz typów MIME, w widoku będą wyświetlane pliki wszystkich typów MIME. |
View.setQuery(string) | W przypadku wyświetleń zawierających wyszukiwania wstępnie uzupełnij zapytanie tym hasłem. |
Wyświetl grupę
ViewGroup to wizualne grupowanie wyświetleń. Elementem głównym samej ViewView musi być View.
ViewGroup(View | ViewId) | ViewGroup to wizualne grupowanie wyświetleń w panelu nawigacji. Głównym elementem ViewGroup musi być View. |
ViewGroup.addLabel(string) | Dodaj etykietę do tego elementu ViewGroup. |
ViewGroup.addView(ViewId | View) | Dodaj widok do ViewGroup. View może być reprezentowany przez obiekt pochodny view lub po prostu przez ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Umieść ViewGroup w obrębie bieżącego zasobu ViewGroup. |
Identyfikator widoku danych
ViewId to wyliczony typ używany do tworzenia obiektów View i ViewGroup.
ViewId.DOCS | Wszystkie typy dokumentów na Dysku Google. |
ViewId.DOCS_IMAGES | Zdjęcia z Dysku Google. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Zdjęcia i filmy z Dysku Google. |
ViewId.DOCS_VIDEOS | Filmy na Dysku Google. |
ViewId.DOCUMENTS | Dokumenty z Dysku Google. |
ViewId.DRAWINGS | Rysunki Google |
ViewId.FOLDERS | Foldery Dysku Google. |
ViewId.FORMS | Formularze na Dysku Google. |
ViewId.PDFS | Pliki PDF zapisane na Dysku Google. |
ViewId.PRESENTATIONS | Prezentacje z Dysku Google. |
ViewId.SPREADSHEETS | Arkusze kalkulacyjne Dysku Google. |
Typy wywołań zwrotnych
W danych wywołania zwrotnego zwracane przez interfejs Google Picker API znajdują się wymienione poniżej typy.
Czynność
Action to wyliczony typ określający działanie wykonane przez użytkownika w celu zamknięcia okna. Ta wartość znajduje się w polu Response.ACTION w danych wywołania zwrotnego.
Action.CANCEL | Użytkownik anulował okno wyboru Google. |
Action.PICKED | Użytkownik wybrał co najmniej 1 element. |
Dokument
Document to wyliczony typ służący do przekazywania informacji o konkretnym elemencie. Zwracane są tylko pola istotne dla wybranego elementu. Ta wartość znajduje się w polu Response.DOCUMENTS w danych wywołania zwrotnego.
Document.DESCRIPTION | Przesłany przez użytkownika opis wybranego elementu. |
Document.DURATION | Czas trwania wybranego filmu. |
Document.EMBEDDABLE_URL | Adres URL elementu, który można umieścić na stronie internetowej. |
Document.ICON_URL | Adres URL ikony tego elementu. |
Document.ID | Identyfikator wybranego elementu. |
Document.IS_NEW | Zwraca wartość „prawda”, jeśli wybrany element został właśnie przesłany. |
Document.LAST_EDITED_UTC | Sygnatura czasowa wskazująca czas ostatniej modyfikacji elementu. |
Document.MIME_TYPE | Typ MIME tego elementu. |
Document.NAME | Nazwa tego elementu. |
Document.NUM_CHILDREN | Liczba elementów podrzędnych zawartych w tym elemencie. Może to być na przykład liczba plików w wybranym folderze. |
Document.PARENT_ID | Identyfikator nadrzędny tego elementu. Na przykład folder zawierający ten plik. |
Document.SERVICE_ID | ServiceId opisujące usługę, z której został wybrany ten element. |
Document.THUMBNAILS | Tablica Thumbnail, która opisuje atrybuty zdjęcia lub filmu. Miniatury nie są zwracane, jeśli wybrane elementy należą do Dysku Google. |
Document.TYPE | Type wybranego elementu. |
Document.URL | Adres URL tego elementu. |
Odpowiedź
Response to wyliczony typ służący do przekazywania informacji o wybranych elementach przez użytkownika.
Response.ACTION | Typ Action oznaczający działanie wykonane przez użytkownika w celu zamknięcia okna. |
Response.DOCUMENTS | Tablica Document wybrana przez użytkownika. |
Response.PARENTS | Identyfikatory folderów nadrzędnych dla wybranych elementów. Mogą to być na przykład identyfikatory folderów nadrzędnych, których pliki zostały wybrane. |
Response.VIEW | View, z którego użytkownik wybrał te elementy. |
Identyfikator usługi
ServiceId to wyliczony typ służący do opisania usługi, z której wybrano element. Ta wartość znajduje się w polu Document.SERVICE_ID wybranego Document.
ServiceId.DOCS | Dysk Google. |
miniatura
Thumbnail to wyliczony typ służący do przekazywania informacji o wybranym zdjęciu lub filmie. Tę wartość można znaleźć w polu Document.THUMBNAILS wybranego Document.
Thumbnail.HEIGHT | Wysokość zdjęcia lub filmu w pikselach. |
Thumbnail.WIDTH | Szerokość zdjęcia lub filmu w pikselach. |
Thumbnail.URL | Adres URL wybranego zdjęcia lub filmu. |
typ
Type to wyliczony typ służący do kategoryzowania wybranego elementu. Tę wartość można znaleźć w polu Document.TYPE wybranego Document.
Type.DOCUMENT | Element jest dokumentem. |
Type.PHOTO | Element jest zdjęciem. |
Type.VIDEO | Element jest filmem. |