Эта страница содержит список классов, методов и перечислимых типов, доступных в API Google Picker. Все эти элементы принадлежат пространству имен google.picker.* Существует два типа классов и перечисляемых типов: те, которые используются для создания и настройки средства выбора Google, и те, которые возвращаются средством выбора Google после того, как пользователь выбрал элемент. элемент.
Классы и типы конфигурации
Следующие классы и перечислимые типы используются для создания и настройки средства выбора Google.
ДокументыЗагрузитьView
Используйте DocsUploadView для загрузки документов на Google Диск.
DocsUploadView() | Конструктор. |
DocsUploadView.setIncludeFolders(boolean) | Позволяет пользователю выбрать папку на Google Диске для загрузки. |
DocsUploadView.setParent(string) | Устанавливает место назначения загрузки в указанную папку. Это переопределяет setIncludeFolders на false. |
Просмотр документов
DocsView — это подкласс View , который можно использовать для представлений на Google Диске.
DocsView( ViewId | undefined) | Конструктор. ViewId должен быть одним из представлений Google Диска. По умолчанию — ViewId.DOCS . |
DocsView.setEnableDrives(boolean) | Показывает общие диски и файлы, которые они содержат. Прежде чем включать, ознакомьтесь с документацией по API Google Drive для включения общих дисков . |
DocsView.setIncludeFolders(boolean) | Показывать папки в элементах просмотра. Не комбинируйте с setOwnedByMe . Если установлен setIncludeFolders(true) , setOwnedByMe игнорируется. |
DocsView.setSelectFolderEnabled(boolean) | Позволяет пользователю выбирать папку на Google Диске. |
DocsView.setMode( DocsViewMode ) | Выбирает режим, используемый представлением для отображения документов. |
DocsView.setOwnedByMe(boolean | undefined) | Фильтрует документы в зависимости от того, принадлежат ли они пользователю или доступны пользователю. Не комбинируйте этот параметр с setIncludeFolders . Если установлен setIncludeFolders(true) , setOwnedByMe игнорируется. |
DocsView.setParent(string) | Устанавливает отображаемую исходную родительскую папку. |
DocsView.setStarred(boolean) | Фильтрует документы на основе того, отмечены ли они пользователем. |
DocsViewMode
DocsViewMode — это перечислимый тип для отображения данных в DocsView. Используйте эти значения при вызовах DocsView.setMode .
DocsViewMode.GRID | Отображение документов в виде сетки миниатюр. |
DocsViewMode.LIST | Отображение документов в подробном списке. |
Особенность
Feature — это перечислимый тип, предназначенный для включения/выключения функций для различных представлений. Используйте эти значения в вызовах PickerBuilder.enableFeature и PickerBuilder.disableFeature .
Feature.MINE_ONLY | При показе объектов с Google Диска показывать только документы, принадлежащие пользователю. |
Feature.MULTISELECT_ENABLED | Разрешить пользователю выбирать более одного элемента. |
Feature.NAV_HIDDEN | Скройте панель навигации. Если панель навигации скрыта, пользователи могут выбирать только из первого выбранного представления. |
Feature.SIMPLE_UPLOAD_ENABLED | При загрузке фотографий определяет, включен ли выбор для каждой фотографии (а не для каждого альбома). |
Feature.SUPPORT_DRIVES | Устарело: объекты общего диска теперь включены по умолчанию. Включаются ли в результаты объекты общего диска. |
Сборщик
Picker — это объект верхнего уровня, представляющий действие пользовательского интерфейса с пользователем. Эти объекты не создаются напрямую, а вместо этого используют объект PickerBuilder .
Picker.isVisible() | Получите логическое значение, указывающее текущую видимость средства выбора. |
Picker.setCallback(function(object)) | Укажите метод обратного вызова, вызываемый всякий раз, когда пользователь выбирает элемент (или отменяет его). |
Picker.setRelayUrl(string) | Укажите URL-адрес ретранслятора, чтобы обойти междоменные проблемы. |
Picker.setVisible(boolean) | Управляйте видимостью объекта Picker. |
Picker.dispose() | Удаляет объект Picker. |
СборщикСтроитель
PickerBuilder используется для создания объектов Picker . Если не указано иное, возвращаемый тип методов ниже имеет тип PickerBuilder , что позволяет вам связывать один вызов в цепочку за другим. См. пример кода Google Picker для типичного использования.
PickerBuilder() | Конструктор. |
PickerBuilder.addView( | Добавьте View на панель навигации. |
PickerBuilder.addViewGroup( ViewGroup ) | Добавьте ViewGroup в панель навигации верхнего уровня. |
PickerBuilder.build() | Создайте объект Picker. Возвращается объект Picker. |
PickerBuilder.disableFeature( Feature ) | Отключите функцию выбора. |
PickerBuilder.enableFeature( Feature ) | Включите функцию выбора. |
PickerBuilder.getRelayUrl() | Получите URL-адрес ретранслятора, используемый для файла elements.rpc. |
PickerBuilder.getTitle() | Получите заголовок диалога. |
PickerBuilder.hideTitleBar() | Отключите отображение строки заголовка. Чтобы повторно включить, вызовите setTitle с непустым заголовком или неопределенным. |
PickerBuilder.isFeatureEnabled( Feature ) | Проверьте, включена ли Feature выбора. |
PickerBuilder.setAppId(string) | Устанавливает идентификатор приложения Google Диска , необходимый для того, чтобы разрешить приложению доступ к файлам пользователя через API Google Диска . |
PickerBuilder.setCallback(method) | Установите метод обратного вызова. Этот метод вызывается, когда пользователь выбирает элементы или отменяет их. Метод обратного вызова получает один объект обратного вызова. Структура объекта обратного вызова описана в JSON Guide . |
PickerBuilder.setDeveloperKey(string) | Устанавливает ключ API браузера, полученный из консоли Google API . Подробную информацию о том, как получить ключ API браузера, см. в Руководстве разработчика . |
PickerBuilder.setDocument(document) | Установите документ. |
PickerBuilder.setLocale(string) | Код языка ISO 639. Если язык не поддерживается, используется en-US. Этот метод предоставляет альтернативу установке локали во время google.load(). Список поддерживаемых локалей см. в Руководстве разработчика . |
PickerBuilder.setMaxItems(number) | Устанавливает максимальное количество элементов, которые может выбрать пользователь. |
PickerBuilder.setOAuthToken(string) | Устанавливает токен OAuth, который будет использоваться для аутентификации текущего пользователя. В зависимости от области действия токена данные отображаются только в определенных представлениях. Допустимые области действия: Документы Google и Диск. |
PickerBuilder.setOrigin(string) | Устанавливает источник диалогового окна выбора Google. В качестве источника следует указать window.location.protocol + '//' + window.location.host самой верхней страницы, если ваше приложение работает в iframe. |
PickerBuilder.setRelayUrl(string) | Установите URL-адрес ретранслятора, используемый для файла elements.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Установите список выбираемых типов MIME. Используйте запятые для разделения типов MIME, если требуется более одного. |
PickerBuilder.setSize() | Установите предпочтительный размер диалогового окна. Диалог автоматически центрируется. Он имеет минимальный размер (566 350) и максимальный размер (1 051 650). |
PickerBuilder.setTitle(string) | Установите заголовок диалога. |
PickerBuilder.toUri() | Возвращает URI, созданный этим строителем. |
идентификатор ресурса
ResourceId — статический класс, используемый для создания идентификаторов ресурсов, подходящих для API списка документов Google.
ResourceId.generate( Document ) | Сопоставьте объект документа с идентификатором ресурса. |
Вид
View — это абстрактный базовый класс для различных классов View, таких как DocsView .
View( ViewId ) | Конструктор. |
View.getId() | Возвращает ViewId для этого представления. |
View.setMimeTypes(string) | Устанавливает типы MIME, включенные в представление. Используйте запятые для разделения типов MIME, если требуется более одного. Если вы не задали типы MIME, в представлении отображаются файлы всех типов MIME. |
View.setQuery(string) | Для представлений, включающих поиск, предварительно заполните поисковый запрос этими терминами. |
Группа просмотра
ViewGroup — это визуальная группировка представлений. Корневой элемент самой ViewGroup должен быть View .
ViewGroup( View | ViewId ) | ViewGroup — это визуальная группа представлений на панели навигации. Корневым элементом самой ViewGroup должен быть View . |
ViewGroup.addLabel(string) | Добавьте метку к этой ViewGroup . |
ViewGroup.addView( ViewId | View ) | Добавьте представление в ViewGroup . View может быть представлено объектом, производным view , или просто ViewId . |
ViewGroup.addViewGroup( ViewGroup ) | Вложите ViewGroup в текущую ViewGroup . |
ViewId
ViewId — это перечислимый тип, используемый для создания объектов View и ViewGroup .
ViewId.DOCS | Все типы документов Google Диска. |
ViewId.DOCS_IMAGES | Фотографии с Google Диска. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Фотографии и видео на Google Диске. |
ViewId.DOCS_VIDEOS | Видео с Google Диска. |
ViewId.DOCUMENTS | Документы Google Диска. |
ViewId.DRAWINGS | Рисунки на Google Диске. |
ViewId.FOLDERS | Папки Google Диска. |
ViewId.FORMS | Формы Google Диска. |
ViewId.PDFS | PDF-файлы, хранящиеся на Google Диске. |
ViewId.PRESENTATIONS | Презентации Google Диска. |
ViewId.SPREADSHEETS | Таблицы Google Диска. |
Типы обратного вызова
Следующие перечислимые типы встречаются в данных обратного вызова, возвращаемых API Google Picker.
Действие
Action — это перечислимый тип, представляющий действие, предпринятое пользователем для закрытия диалогового окна. Это значение находится в поле Response.ACTION в данных обратного вызова.
Action.CANCEL | Пользователь закрыл диалоговое окно выбора Google. |
Action.PICKED | Пользователь выбрал хотя бы один элемент. |
Документ
Document — это перечислимый тип, используемый для передачи информации о конкретном выбранном элементе. Возвращаются только поля, относящиеся к выбранному элементу. Это значение находится в поле Response.DOCUMENTS в данных обратного вызова.
Document.DESCRIPTION | Введенное пользователем описание выбранного элемента. |
Document.DURATION | Продолжительность выбранного видео. |
Document.EMBEDDABLE_URL | URL-адрес этого элемента, подходящий для встраивания в веб-страницу. |
Document.ICON_URL | URL-адрес значка этого элемента. |
Document.ID | Идентификатор выбранного элемента. |
Document.IS_NEW | Возвращает true, если выбранный элемент был только что загружен. |
Document.LAST_EDITED_UTC | Временная метка, описывающая дату последнего редактирования этого элемента. |
Document.MIME_TYPE | MIME-тип этого элемента. |
Document.NAME | Название этого предмета. |
Document.NUM_CHILDREN | Количество детей, содержащихся в этом элементе. Например, количество файлов в выбранной папке. |
Document.PARENT_ID | Родительский идентификатор этого элемента. Например, папка, содержащая этот файл. |
Document.SERVICE_ID | ServiceId описывающий службу, из которой был выбран этот элемент. |
Document.THUMBNAILS | Массив Thumbnail , описывающий атрибуты фотографии или видео. Миниатюры не возвращаются, если выбранные элементы принадлежат Google Диску. |
Document.TYPE | Type выбранного элемента. |
Document.URL | URL-адрес этого элемента. |
Ответ
Response — это перечислимый тип, используемый для передачи информации о выбранных пользователем элементах.
Response.ACTION | Тип Action , представляющий действие, предпринятое пользователем для закрытия диалогового окна. |
Response.DOCUMENTS | Массив Document , выбранный пользователем. |
Response.PARENTS | Идентификаторы родительских папок для выбранных элементов. (Например, идентификаторы родительских папок, файлы которых были выбраны.) |
Response.VIEW | View из которого пользователь выбрал эти элементы. |
идентификатор службы
ServiceId — это перечислимый тип, используемый для описания службы, из которой был выбран элемент. Это значение находится в поле Document.SERVICE_ID выбранного Document .
ServiceId.DOCS | Гугл Диск. |
миниатюра
Thumbnail — это перечислимый тип, используемый для передачи информации о выбранной фотографии или видео. Это значение можно найти в поле Document.THUMBNAILS выбранного Document .
Thumbnail.HEIGHT | Высота фото или видео в пикселях. |
Thumbnail.WIDTH | Ширина фото или видео в пикселях. |
Thumbnail.URL | URL-адрес выбранной фотографии или видео. |
тип
Type — перечисляемый тип, используемый для категоризации выбранного элемента. Это значение можно найти в поле Document.TYPE выбранного Document .
Type.DOCUMENT | Товар является документом. |
Type.PHOTO | Товар представляет собой фотографию. |
Type.VIDEO | Товар представляет собой видео. |