En esta página, se incluye una lista de clases, métodos y tipos enumerados disponibles en la API de selector de Google. Todos estos elementos pertenecen al espacio de nombres google.picker.*
. Hay 2 tipos de clases y tipos enumerados: las que se usan para compilar y configurar el selector de Google y las que muestra el selector de Google una vez que el usuario selecciona un elemento.
Tipos y clases de configuración
Las siguientes clases y los tipos enumerados se utilizan para compilar y configurar el selector de Google.
DocsUploadView
Usa DocsUploadView
para subir documentos a Google Drive.
DocsUploadView() | Constructor. |
DocsUploadView.setIncludeFolders(boolean) | Permite que el usuario seleccione una carpeta de Google Drive para realizar la carga. |
DocsUploadView.setParent(string) | Establece el destino de carga en la carpeta especificada. Esto anula setIncludeFolders como falso. |
DocsView
DocsView
es una subclase de View
que se puede usar para las vistas de Google Drive.
DocsView(ViewId | undefined) | Constructor. El elemento ViewId debe ser una de las vistas de Google Drive. El valor predeterminado es ViewId.DOCS . |
DocsView.setEnableDrives(boolean) | Muestra las unidades compartidas y los archivos que contienen. Antes de habilitar la función, consulta la documentación de la API de Google Drive para habilitar unidades compartidas. |
DocsView.setIncludeFolders(boolean) | Mostrar carpetas en los elementos de la vista No las combines con setOwnedByMe . Cuando se configura setIncludeFolders(true) , se ignora setOwnedByMe . |
DocsView.setSelectFolderEnabled(boolean) | Permite que el usuario seleccione una carpeta en Google Drive. |
DocsView.setMode(DocsViewMode) | Selecciona el modo que usa la vista para mostrar los documentos. |
DocsView.setOwnedByMe(boolean | undefined) | Filtra los documentos según si son propiedad del usuario o si se comparten con este. No combines este parámetro de configuración con setIncludeFolders . Cuando se configura setIncludeFolders(true) , se ignora setOwnedByMe . |
DocsView.setParent(string) | Configura la carpeta superior inicial que se mostrará. |
DocsView.setStarred(boolean) | Filtra los documentos en función de si el usuario los destacó. |
DocsViewMode
DocsViewMode
es un tipo enumerado para mostrar datos dentro de una DocsView. Usa estos valores en las llamadas a DocsView.setMode
.
DocsViewMode.GRID | Muestra los documentos en una cuadrícula de miniaturas. |
DocsViewMode.LIST | Muestra los documentos en una lista detallada. |
Ingeniería
Feature
es un tipo enumerado para activar o desactivar atributos para varias vistas. Usa estos valores en las llamadas a PickerBuilder.enableFeature
y PickerBuilder.disableFeature
.
Feature.MINE_ONLY | Mostrar solo documentos que sean propiedad del usuario al mostrar elementos de Google Drive |
Feature.MULTISELECT_ENABLED | Permitir que el usuario elija más de un elemento. |
Feature.NAV_HIDDEN | Ocultar el panel de navegación Si el panel de navegación está oculto, los usuarios solo podrán elegir la primera vista. |
Feature.SIMPLE_UPLOAD_ENABLED | En el caso de las cargas de fotos, controla si se habilita la selección por foto (en lugar de la selección por álbum). |
Feature.SUPPORT_DRIVES |
Obsoleto: Los elementos de las unidades compartidas ahora se incluyen de forma predeterminada. Indica si los elementos de la unidad compartida se incluyen en los resultados. |
Selector
Picker
es el objeto de nivel superior que representa la acción de la IU con el usuario. Estos objetos no se crean directamente, sino que usan el objeto PickerBuilder
.
Picker.isVisible() | Obtén un valor booleano que indica la visibilidad actual del selector. |
Picker.setCallback(function(object)) | Especifica el método de devolución de llamada al que se llama cada vez que el usuario selecciona un elemento (o lo cancela). |
Picker.setRelayUrl(string) | Especifique una URL de retransmisión para eludir problemas multidominio. |
Picker.setVisible(boolean) | Controla la visibilidad del objeto del selector. |
Picker.dispose() | Elimina el objeto del selector. |
PickerBuilder
PickerBuilder
se usa para crear objetos Picker
. Excepto cuando se indique lo contrario, el tipo de datos que se muestra a continuación es de tipo PickerBuilder
, lo que te permite encadenar una llamada tras otra. Consulta la muestra de código del selector de Google para ver un uso habitual.
PickerBuilder() | Constructor. |
PickerBuilder.addView( | Agrega un objeto View al panel de navegación. |
PickerBuilder.addViewGroup(ViewGroup) | Agrega un objeto ViewGroup al panel de navegación de nivel superior. |
PickerBuilder.build() | Construye el objeto Picker. Se muestra el objeto del selector. |
PickerBuilder.disableFeature(Feature) | Inhabilita una función del selector. |
PickerBuilder.enableFeature(Feature) | Habilita una función de selector. |
PickerBuilder.getRelayUrl() | Obtén la URL de retransmisión, que se utiliza para gadgets.rpc. |
PickerBuilder.getTitle() | Obtén el título del diálogo. |
PickerBuilder.hideTitleBar() | Inhabilitar la barra de título para que no se muestre. Para volver a habilitarla, llama a setTitle con un título que no esté vacío o no esté definido. |
PickerBuilder.isFeatureEnabled(Feature) | Verifica si un selector Feature está habilitado. |
PickerBuilder.setAppId(string) | Establece el ID de app de Google Drive necesario para permitir que la aplicación acceda a los archivos del usuario a través de la API de Google Drive. |
PickerBuilder.setCallback(method) | Configura el método de devolución de llamada. Se llama a este método cuando el usuario selecciona elementos o cancela. El método de devolución de llamada recibe un solo objeto de devolución de llamada. La estructura del objeto de devolución de llamada se describe en la Guía de JSON. |
PickerBuilder.setDeveloperKey(string) | Configura la clave de API del navegador que se obtiene de la Consola de API de Google. Consulta la Guía para desarrolladores para obtener detalles sobre cómo obtener la clave de API del navegador. |
PickerBuilder.setDocument(document) | Configura el documento. |
PickerBuilder.setLocale(string) | Código de idioma ISO 639. Si el idioma no es compatible, se usa en-US. Este método proporciona una alternativa a la configuración de la configuración regional en el tiempo de google.load(). Consulta la Guía para desarrolladores para obtener una lista de las configuraciones regionales compatibles. |
PickerBuilder.setMaxItems(number) | Establece la cantidad máxima de elementos que puede seleccionar un usuario. |
PickerBuilder.setOAuthToken(string) | Configura un token de OAuth para autenticar al usuario actual. Según el alcance del token, solo algunas vistas muestran datos. Los permisos válidos son Documentos de Google y Drive. |
PickerBuilder.setOrigin(string) | Establece el origen del cuadro de diálogo del selector de Google. Si la aplicación se está ejecutando en un iframe, el origen debe establecerse en el window.location.protocol + '//' + window.location.host de la página superior. |
PickerBuilder.setRelayUrl(string) | Configura la URL de retransmisión, que se utiliza para gadgets.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Establece la lista de tipos de MIME seleccionables. Usa comas para separar los tipos de MIME si se requiere más de uno. |
PickerBuilder.setSize() | Configura el tamaño de diálogo preferido. El diálogo se centra automáticamente. Tiene un tamaño mínimo de (566,350) y un tamaño máximo de (1,051,650). |
PickerBuilder.setTitle(string) | Establece el título del diálogo. |
PickerBuilder.toUri() | Muestra el URI que generó este compilador. |
ResourceId
ResourceId
es una clase estática que se utiliza para generar IDs de recursos adecuados para la API de Google Documents List.
ResourceId.generate(Document) | Asigna un objeto de documento a un ID de recurso. |
Ver
View
es la clase base abstracta para varias clases de vistas, como DocsView
.
View(ViewId) | Constructor. |
View.getId() | Muestra el ViewId de esta vista. |
View.setMimeTypes(string) | Establece los tipos de MIME incluidos en la vista. Usa comas para separar los tipos de MIME si se requiere más de uno. Si no estableces los tipos de MIME, los archivos de todos los tipos de MIME se mostrarán en la vista. |
View.setQuery(string) | Para las vistas que incluyen búsquedas, completa previamente la búsqueda con estos términos. |
ViewGroup
ViewGroup
es una agrupación visual de vistas. El elemento raíz del objeto ViewGroup debe ser un View
.
ViewGroup(View | ViewId) | Un objeto ViewGroup es una agrupación visual de vistas en el panel de navegación. El elemento raíz de ViewGroup en sí debe ser View . |
ViewGroup.addLabel(string) | Agrega una etiqueta a esta ViewGroup . |
ViewGroup.addView(ViewId | View) | Agrega una vista a ViewGroup . View se puede representar con un objeto derivado de view o simplemente por ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Anida un ViewGroup en el ViewGroup actual. |
ViewId
ViewId
es un tipo enumerado que se usa para construir objetos View
y ViewGroup
.
ViewId.DOCS | Todos los tipos de documentos de Google Drive. |
ViewId.DOCS_IMAGES | Fotos de Google Drive |
ViewId.DOCS_IMAGES_AND_VIDEOS | Fotos y videos de Google Drive |
ViewId.DOCS_VIDEOS | Videos de Google Drive |
ViewId.DOCUMENTS | Documentos de Google Drive |
ViewId.DRAWINGS | Dibujos de Google Drive |
ViewId.FOLDERS | Carpetas de Google Drive. |
ViewId.FORMS | Formularios de Google Drive |
ViewId.PDFS | Archivos PDF almacenados en Google Drive. |
ViewId.PRESENTATIONS | Presentaciones de Google Drive |
ViewId.SPREADSHEETS | Hojas de cálculo de Google Drive |
Tipos de devolución de llamada
Los siguientes tipos enumerados se encuentran en los datos de devolución de llamada que muestra la API de selector de Google.
Acción
Action
es un tipo enumerado que representa la acción que realizó el usuario para descartar el diálogo. Este valor se encuentra en el campo Response.ACTION
de los datos de la devolución de llamada.
Action.CANCEL | El usuario canceló el cuadro de diálogo del Selector de Google. |
Action.PICKED | El usuario eligió al menos un elemento. |
Documento
Document
es un tipo enumerado que se usa para transmitir información sobre un elemento seleccionado específico. Solo se muestran los campos que son relevantes para el elemento seleccionado. Este valor se encuentra en el campo Response.DOCUMENTS
de los datos de la devolución de llamada.
Document.DESCRIPTION | Una descripción del elemento seleccionado aportada por el usuario. |
Document.DURATION | Es la duración de un video seleccionado. |
Document.EMBEDDABLE_URL | Una URL para este elemento adecuada para incorporarse en una página web. |
Document.ICON_URL | Una URL a un ícono para este elemento. |
Document.ID | Es el ID del elemento seleccionado. |
Document.IS_NEW | Muestra el valor true si el elemento seleccionado se acaba de subir. |
Document.LAST_EDITED_UTC | La marca de tiempo que describe cuándo se editó este elemento por última vez. |
Document.MIME_TYPE | Es el tipo de MIME de este elemento. |
Document.NAME | Es el nombre de este elemento. |
Document.NUM_CHILDREN | Indica la cantidad de elementos secundarios incluidos en este elemento. Por ejemplo, la cantidad de archivos en la carpeta seleccionada. |
Document.PARENT_ID | El ID principal de este elemento. Por ejemplo, la carpeta que contiene este archivo. |
Document.SERVICE_ID | Un objeto ServiceId que describe el servicio desde el que se seleccionó este elemento. |
Document.THUMBNAILS | Es un array de Thumbnail que describe los atributos de una foto o un video. Las miniaturas no se muestran si los elementos seleccionados pertenecen a Google Drive. |
Document.TYPE | El Type del elemento seleccionado |
Document.URL | Una URL a este elemento. |
Respuesta
Response
es un tipo enumerado que se usa para transmitir información sobre los elementos seleccionados por el usuario.
Response.ACTION | Un tipo Action que representa la acción que realizó el usuario para descartar el diálogo |
Response.DOCUMENTS | Un array de Document que selecciona el usuario. |
Response.PARENTS | Los ID de las carpetas superiores de los elementos seleccionados. (por ejemplo, los IDs de las carpetas superiores cuyos archivos se seleccionaron). |
Response.VIEW | Es el View del que el usuario seleccionó estos elementos. |
ID de servicio
ServiceId
es un tipo enumerado que se usa para describir el servicio desde el que se seleccionó el elemento. Este valor se encuentra en el campo Document.SERVICE_ID
del Document
seleccionado.
ServiceId.DOCS | Google Drive. |
miniatura
Thumbnail
es un tipo enumerado que se usa para transmitir información sobre una foto o un video seleccionados. Este valor se encuentra en el campo Document.THUMBNAILS
de un Document
seleccionado.
Thumbnail.HEIGHT | La altura de la foto o el video en píxeles. |
Thumbnail.WIDTH | Es el ancho de la foto o el video en píxeles. |
Thumbnail.URL | Una URL a la foto o el video seleccionado. |
Tipo
Type
es un tipo enumerado que se usa para categorizar el elemento seleccionado. Este valor se encuentra en el campo Document.TYPE
de un Document
seleccionado.
Type.DOCUMENT | El elemento es un documento. |
Type.PHOTO | El elemento es una foto. |
Type.VIDEO | El elemento es un video. |