Ta strona zawiera listę klas, metod i wymienionych typów dostępnych w interfejsie Google Picker API. Wszystkie te elementy należą do przestrzeni nazw.google.picker.*Istnieją 2 typy klas i typy wyliczane: te, które są używane do tworzenia i konfigurowania selektora Google, oraz te, które są zwracane przez selektor Google, gdy użytkownik wybierze element.
Klasy i typy konfiguracji
Do kompilowania i konfigurowania selektora Google służą poniższe klasy i typy wyliczane.
DocsUploadView
Użyj usługi DocsUploadView, aby przesłać dokumenty na Dysk Google.
DocsUploadView() | Konstruktor. |
DocsUploadView.setIncludeFolders(boolean) | Umożliwia użytkownikowi wybranie folderu na Dysku Google, do którego ma być przesyłana treść. |
DocsUploadView.setParent(string) | Ustawia miejsce docelowe przesyłania na określony folder. Spowoduje to zastąpienie wartości setIncludeFolders wartością fałsz. |
DocsView
DocsView to podklasa klasy View, której można używać do obsługi widoków Dysku Google.
DocsView(ViewId | undefined) | Konstruktor. ViewId musi być jednym z widoków Dysku Google. Wartość domyślna to ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Wyświetla dyski współdzielone i znajdujące się na 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) | Pokaż foldery w elementach widoku. Nie łącz z właściwością setOwnedByMe. Jeśli zasada setIncludeFolders(true) jest skonfigurowana, setOwnedByMe jest ignorowana. |
DocsView.setSelectFolderEnabled(boolean) | Pozwala użytkownikowi wybrać folder na Dysku Google. |
DocsView.setMode(DocsViewMode) | Pozwala wybrać tryb, w którym widok będzie wyświetlać dokumenty. |
DocsView.setOwnedByMe(boolean | undefined) | Filtruje dokumenty na podstawie tego, czy są one własnością użytkownika czy zostały mu udostępnione. Nie łącz tego ustawienia z zasadą setIncludeFolders. Jeśli zasada setIncludeFolders(true) jest skonfigurowana, setOwnedByMe jest ignorowana. |
DocsView.setParent(string) | Określa wyświetlany początkowy folder nadrzędny. |
DocsView.setStarred(boolean) | Filtruje dokumenty na podstawie tego, czy użytkownik oznaczył je gwiazdką. |
DocsViewMode
DocsViewMode jest typem wyliczonym służącym do wyświetlania danych w elemencie DocumentView. Używaj tych wartości w wywołaniach funkcji DocsView.setMode.
DocsViewMode.GRID | Wyświetlaj dokumenty w siatce miniatur. |
DocsViewMode.LIST | Wyświetlaj dokumenty na szczegółowej liście. |
Funkcja
Feature to typ listy służący do włączania i wyłączania funkcji w różnych widokach. Używaj tych wartości w wywołaniach funkcji PickerBuilder.enableFeature i PickerBuilder.disableFeature.
Feature.MINE_ONLY | Podczas wyświetlania elementów z Dysku Google pokazuj tylko dokumenty należące do użytkownika. |
Feature.MULTISELECT_ENABLED | Zezwalaj użytkownikowi na wybranie więcej niż 1 elementu. |
Feature.NAV_HIDDEN | Ukryj panel nawigacji. Jeśli panel nawigacji jest ukryty, użytkownicy mogą wybierać tylko z pierwszego wybranego widoku. |
Feature.SIMPLE_UPLOAD_ENABLED | W przypadku przesyłanych zdjęć to ustawienie określa, czy zaznaczanie dla poszczególnych zdjęć (a nie dla całego albumu) ma być włączone. |
Feature.SUPPORT_DRIVES |
Wycofano: elementy z dysków współdzielonych są teraz domyślnie uwzględniane. Określa, czy elementy z dysku współdzielonego są uwzględniane w wynikach. |
Selektor
Picker to obiekt najwyższego poziomu reprezentujący działanie interfejsu użytkownika. Te obiekty nie są tworzone bezpośrednio, ale zamiast tego używają obiektu PickerBuilder.
Picker.isVisible() | Pobierz wartość logiczną wskazującą aktualną widoczność selektora. |
Picker.setCallback(function(object)) | Określ metodę wywołania zwrotnego wywoływaną za każdym razem, gdy użytkownik wybiera element (lub anulujesz). |
Picker.setRelayUrl(string) | Określ adres URL usługi przekaźnika, aby obejść problemy z połączeniem między domenami. |
Picker.setVisible(boolean) | Kontroluj widoczność obiektu selektora. |
Picker.dispose() | Usuwa obiekt selektora. |
PickerBuilder
PickerBuilder służy do tworzenia obiektów Picker. O ile nie wskazano inaczej, zwracany typ metod poniżej jest typu PickerBuilder, co umożliwia łączenie wywołań po kolei. Informacje o typowych zastosowaniach znajdziesz w przykładowym kodzie selektora Google.
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 selektora. Zwracany jest obiekt selektora. |
PickerBuilder.disableFeature(Feature) | Wyłącz selektor. |
PickerBuilder.enableFeature(Feature) | Włącz selektor. |
PickerBuilder.getRelayUrl() | Uzyskaj adres URL usługi przekaźnika używany w pliku Gadget.rpc. |
PickerBuilder.getTitle() | Uzyskaj tytuł okna dialogowego. |
PickerBuilder.hideTitleBar() | Wyłącz wyświetlanie paska tytułu. Aby ponownie włączyć tę funkcję, wywołaj funkcję setTitle, podając niepusty lub niezdefiniowany tytuł. |
PickerBuilder.isFeatureEnabled(Feature) | Sprawdź, czy selektor Feature jest włączony. |
PickerBuilder.setAppId(string) | Ustawia identyfikator aplikacji Dysku Google, który jest potrzebny, aby aplikacja mogła uzyskiwać dostęp do 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 wybiera elementy lub anuluje. Metoda wywołania zwrotnego odbiera pojedynczy obiekt wywołania zwrotnego. Struktura obiektu wywołania zwrotnego jest opisana w przewodniku dotyczącym JSON. |
PickerBuilder.setDeveloperKey(string) | Ustawia klucz interfejsu API przeglądarki uzyskany z Konsoli interfejsów API Google. Szczegółowe informacje o tym, jak uzyskać klucz interfejsu API przeglądarki, 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 ustawiania ustawień regionalnych na czas 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, który będzie używany do uwierzytelniania bieżącego użytkownika. W zależności od zakresu tokena dane są wyświetlane tylko w niektórych widokach. Prawidłowe zakresy to Dokumenty i Dysk Google. |
PickerBuilder.setOrigin(string) | Ustawia pochodzenie okna Selektora Google. Jeśli aplikacja działa w elemencie iframe, źródło powinno być ustawione na window.location.protocol + '//' + window.location.host najwyższej strony. |
PickerBuilder.setRelayUrl(string) | Ustaw adres URL przekaźnika używany w pliku Gadget.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Ustaw listę typów MIME, które można wybrać. Jeśli wymagany jest więcej niż jeden typ MIME, rozdziel je przecinkami. |
PickerBuilder.setSize() | Ustaw preferowany rozmiar okna. Okno jest automatycznie wyśrodkowane. Jego minimalny rozmiar to 566 350, a maksymalny (1051 650). |
PickerBuilder.setTitle(string) | Ustaw tytuł okna. |
PickerBuilder.toUri() | Zwraca identyfikator URI wygenerowany przez ten monter. |
ResourceId
ResourceId to klasa statyczna używana do generowania identyfikatorów zasobów odpowiednich dla interfejsu API listy Dokumentów Google.
ResourceId.generate(Document) | Zmapuj obiekt dokumentu na identyfikator zasobu. |
Wyświetl
View to abstrakcyjna klasa bazowa dla różnych klas widoku danych, takich jak DocsView.
View(ViewId) | Konstruktor. |
View.getId() | Zwraca parametr ViewId tego widoku. |
View.setMimeTypes(string) | Ustawia typy MIME widoczne w widoku. Jeśli wymagany jest więcej niż jeden typ 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 widoków danych obejmujących wyszukiwania należy wstępnie wypełnić zapytanie tymi hasłami. |
ViewGroup
ViewGroup to wizualna grupa widoków danych. Elementem głównym samej grupy widoków musi być View.
ViewGroup(View | ViewId) | ViewGroup to wizualna grupa widoków w panelu nawigacji. Elementem głównym elementu ViewGroup musi być View. |
ViewGroup.addLabel(string) | Dodaj etykietę do tego elementu: ViewGroup. |
ViewGroup.addView(ViewId | View) | Dodaj widok do ViewGroup. Element View może być reprezentowany przez obiekt pochodzący z view lub po prostu za pomocą identyfikatora ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Umieść ViewGroup w bieżącym ViewGroup. |
ViewId
ViewId to typ wyliczeniowy 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 z Dysku Google. |
ViewId.DOCUMENTS | Dokumenty z Dysku Google. |
ViewId.DRAWINGS | Rysunki z Dysku Google. |
ViewId.FOLDERS | Folderach Dysku Google. |
ViewId.FORMS | Formularze na Dysku Google. |
ViewId.PDFS | PDF-ów przechowywanych na Dysku Google. |
ViewId.PRESENTATIONS | Prezentacje z Dysku Google. |
ViewId.SPREADSHEETS | Arkusze kalkulacyjne Dysku Google. |
Typy wywołań zwrotnych
W danych wywołania zwrotnego zwracanych przez interfejs Google Picker API można znaleźć wymienione poniżej typy.
Działanie
Action to typ wyliczeniowy reprezentujący działanie wykonane przez użytkownika w celu zamknięcia okna. Ta wartość znajduje się w polu Response.ACTION danych wywołania zwrotnego.
Action.CANCEL | Użytkownik anulował okno selektora Google. |
Action.PICKED | Użytkownik wybrał co najmniej jeden produkt. |
Dokumenty
Document to typ numeryczny służący do przekazywania informacji o konkretnym wybranym elemencie. Zwracane są tylko pola, które są odpowiednie dla wybranego elementu. Ta wartość znajduje się w polu Response.DOCUMENTS danych wywołania zwrotnego.
Document.DESCRIPTION | Opis wybrany przez użytkownika. |
Document.DURATION | Czas trwania wybranego filmu. |
Document.EMBEDDABLE_URL | Adres URL tego elementu odpowiedni do umieszczenia na stronie internetowej. |
Document.ICON_URL | Adres URL ikony tego elementu. |
Document.ID | Identyfikator wybranego elementu. |
Document.IS_NEW | Zwraca wartość „true”, jeśli wybrany element został właśnie przesłany. |
Document.LAST_EDITED_UTC | Sygnatura czasowa wskazująca, kiedy ten element był ostatnio edytowany. |
Document.MIME_TYPE | Typ MIME tego elementu. |
Document.NAME | Nazwa tego elementu. |
Document.NUM_CHILDREN | Liczba elementów podrzędnych w tym elemencie. Może to być na przykład liczba plików w wybranym folderze. |
Document.PARENT_ID | Identyfikator nadrzędny tego elementu. Może to być na przykład folder zawierający ten plik. |
Document.SERVICE_ID | Atrybut ServiceId opisujący usługę, z której został wybrany ten produkt. |
Document.THUMBNAILS | Tablica znaczników Thumbnail opisujących atrybuty zdjęcia lub filmu. Miniatury nie są zwracane, jeśli wybrane elementy należą do Dysku Google. |
Document.TYPE | Wartość Type wybranego elementu. |
Document.URL | Adres URL tego elementu. |
Odpowiedź
Response to typ numeryczny służący do przekazywania informacji o elementach wybranych przez użytkownika.
Response.ACTION | Typ Action reprezentujący działanie wykonane przez użytkownika w celu zamknięcia okna. |
Response.DOCUMENTS | Tablica elementów Document wybranych przez użytkownika. |
Response.PARENTS | Identyfikatory folderów nadrzędnych wybranych elementów. 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 typ numeryczny używany do opisania usługi, z której został wybrany element. Ta wartość znajduje się w polu Document.SERVICE_ID wybranego elementu Document.
ServiceId.DOCS | Dysk Google. |
miniatura
Thumbnail to typ numeryczny służący do przekazywania informacji o wybranym zdjęciu lub filmie. Tę wartość można znaleźć w polu Document.THUMBNAILS wybranego elementu 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. |
Niestandardowy typ treści
Type to typ wyliczony używany do kategoryzowania wybranego elementu. Tę wartość można znaleźć w polu Document.TYPE wybranego elementu Document.
Type.DOCUMENT | Element jest dokumentem. |
Type.PHOTO | Produkt jest zdjęciem. |
Type.VIDEO | Produktem jest film. |