Esta página contém uma lista de classes, métodos e tipos enumerados disponíveis na API Google Picker. Todos esses elementos pertencem ao namespace google.picker.*.
Existem dois tipos de classes e tipos enumerados: os usados para criar e configurar
o seletor do Google e os retornados pelo seletor do Google depois que o usuário
selecionar um item.
Classes e tipos de configuração
As classes e os tipos enumerados a seguir são usados para criar e configurar o seletor do Google.
Envio de documentos
Use o DocsUploadView para fazer upload de documentos para o Google Drive.
DocsUploadView() | Construtor. |
DocsUploadView.setIncludeFolders(boolean) | Permite que o usuário selecione uma pasta no Google Drive para fazer upload. |
DocsUploadView.setParent(string) | Define o destino de upload para a pasta especificada. Isso substitui setIncludeFolders para falso. |
Visualização do Documentos
A DocsView é uma subclasse do View que pode ser usada para visualizações do Google Drive.
DocsView(ViewId | undefined) | Construtor. O ViewId precisa ser uma das visualizações do Google Drive. O padrão é ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Mostra os drives compartilhados e os arquivos que eles contêm. Antes de ativar, consulte a documentação da API Google Drive para ativar drives compartilhados. |
DocsView.setIncludeFolders(boolean) | Mostrar pastas nos itens de visualização. Não combine com setOwnedByMe. Quando setIncludeFolders(true) é definido, o setOwnedByMe é ignorado. |
DocsView.setSelectFolderEnabled(boolean) | Permite que o usuário selecione uma pasta no Google Drive. |
DocsView.setMode(DocsViewMode) | Seleciona o modo que a visualização usa para exibir os documentos. |
DocsView.setOwnedByMe(boolean | undefined) | Filtra os documentos com base na propriedade ou no compartilhamento deles. Não combine essa configuração com setIncludeFolders. Quando setIncludeFolders(true) é definido, o setOwnedByMe é ignorado. |
DocsView.setParent(string) | Define a pasta mãe inicial a ser exibida. |
DocsView.setStarred(boolean) | Filtra os documentos com base na indicação deles. |
Modo de visualização do documento
DocsViewMode é um tipo enumerado para exibir dados em uma visualização de documento. Use esses valores em chamadas para DocsView.setMode.
DocsViewMode.GRID | Mostre documentos em uma grade de miniaturas. |
DocsViewMode.LIST | Exiba documentos em uma lista detalhada. |
Recurso
Feature é um tipo enumerado para ativar/desativar recursos para várias visualizações. Use esses valores em chamadas para PickerBuilder.enableFeature e PickerBuilder.disableFeature.
Feature.MINE_ONLY | Mostrar apenas os documentos que pertencem ao usuário ao exibir itens do Google Drive. |
Feature.MULTISELECT_ENABLED | Permitir que o usuário escolha mais de um item. |
Feature.NAV_HIDDEN | Ocultar o painel de navegação. Se o painel de navegação estiver oculto, os usuários só poderão selecionar na primeira visualização escolhida. |
Feature.SIMPLE_UPLOAD_ENABLED | Para uploads de fotos, controla se a seleção por foto (e não por álbum) está ativada. |
Feature.SUPPORT_DRIVES |
Obsoleto: os itens do drive compartilhado agora são incluídos por padrão. Indica se os itens do drive compartilhado estão incluídos nos resultados. |
Seletor
Picker é o objeto de nível superior que representa a ação da IU com o usuário. Esses objetos não são criados diretamente, mas usam o objeto PickerBuilder.
Picker.isVisible() | Recebe um booleano que indica a visibilidade atual do seletor. |
Picker.setCallback(function(object)) | Especifique o método de callback chamado sempre que o usuário selecionar um item (ou cancelar). |
Picker.setRelayUrl(string) | Especifique um URL de redirecionamento para contornar problemas de vários domínios. |
Picker.setVisible(boolean) | Controla a visibilidade do objeto Picker. |
Picker.dispose() | Descarta o objeto Picker. |
PickerBuilder
O PickerBuilder é usado para criar objetos Picker. Exceto quando indicado o contrário, o tipo de retorno de métodos abaixo é do tipo PickerBuilder, permitindo que você encadeie uma chamada após a outra. Consulte o exemplo de código do seletor do Google para ver o uso típico.
PickerBuilder() | Construtor. |
PickerBuilder.addView( | Adicione um View ao painel de navegação. |
PickerBuilder.addViewGroup(ViewGroup) | Adicione um ViewGroup ao painel de navegação de nível superior. |
PickerBuilder.build() | Crie o objeto Picker. O objeto Picker é retornado. |
PickerBuilder.disableFeature(Feature) | Desativar um recurso seletor. |
PickerBuilder.enableFeature(Feature) | Ativar um recurso de seleção. |
PickerBuilder.getRelayUrl() | Acesse o URL de redirecionamento usado para gadgets.rpc. |
PickerBuilder.getTitle() | Encontre o título da caixa de diálogo. |
PickerBuilder.hideTitleBar() | Desativar a exibição da barra de título. Para reativar, chame setTitle com um título não vazio ou indefinido. |
PickerBuilder.isFeatureEnabled(Feature) | Confira se um seletor Feature está ativado. |
PickerBuilder.setAppId(string) | Define o ID do app Google Drive necessário para permitir que o app acesse os arquivos do usuário pela API Google Drive. |
PickerBuilder.setCallback(method) | Defina o método de callback. Esse método é chamado quando o usuário seleciona ou cancela itens. O método de callback recebe um único objeto de callback. A estrutura do objeto de callback é descrita no Guia do JSON. |
PickerBuilder.setDeveloperKey(string) | Define a chave de API do navegador recebida do Console de APIs do Google. Consulte o guia para desenvolvedores e veja detalhes sobre como conseguir a chave de API do navegador. |
PickerBuilder.setDocument(document) | Defina o documento. |
PickerBuilder.setLocale(string) | Código de idioma ISO 639. Se o idioma não for compatível, será usado en-US. Esse método oferece uma alternativa à definição da localidade no horário google.load(). Consulte o Guia do desenvolvedor para ver uma lista de localidades compatíveis. |
PickerBuilder.setMaxItems(number) | Define o número máximo de itens que um usuário pode selecionar. |
PickerBuilder.setOAuthToken(string) | Define um token OAuth a ser usado para autenticar o usuário atual. Dependendo do escopo do token, apenas algumas visualizações exibem dados. Os escopos válidos são Documentos Google, Drive, Fotos, YouTube. |
PickerBuilder.setOrigin(string) | Define a origem da caixa de diálogo do seletor do Google. A origem precisa ser definida como a window.location.protocol + '//' + window.location.host da página superior, caso o app esteja em execução em um iframe. |
PickerBuilder.setRelayUrl(string) | Define o URL de redirecionamento usado para gadgets.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Define a lista de tipos MIME selecionáveis. Use vírgulas para separar tipos MIME caso mais de um seja necessário. |
PickerBuilder.setSize() | Defina o tamanho preferido da caixa de diálogo. A caixa de diálogo é centralizada automaticamente. O tamanho mínimo é de (566.350) e máximo (1.051.650). |
PickerBuilder.setTitle(string) | Defina o título da caixa de diálogo. |
PickerBuilder.toUri() | Retorna o URI gerado por esse builder. |
ResourceId
ResourceId é uma classe estática usada para gerar IDs de recursos adequados para a API Google Documents List.
ResourceId.generate(Document) | Mapear um objeto de documento para um código de recurso. |
Acessar
View é a classe base abstrata para as várias classes de visualização, como DocsView.
View(ViewId) | Construtor. |
View.getId() | Retorna o ViewId desta visualização. |
View.setMimeTypes(string) | Define os tipos MIME incluídos na visualização. Use vírgulas para separar tipos MIME caso mais de um seja necessário. Se você não definir tipos MIME, os arquivos de todos os tipos MIME serão exibidos na visualização. |
View.setQuery(string) | Para visualizações que envolvem pesquisas, preencha previamente a consulta com esses termos. |
ViewGroup
ViewGroup é um agrupamento visual de visualizações. O item raiz do próprio ViewGroup precisa ser um View.
ViewGroup(View | ViewId) | Um ViewGroup é um agrupamento visual de visualizações no painel de navegação. O item raiz do próprio ViewGroup precisa ser View. |
ViewGroup.addLabel(string) | Adicione um marcador a este ViewGroup. |
ViewGroup.addView(ViewId | View) | Adicione uma visualização ao ViewGroup. O View pode ser representado por um objeto derivado do view ou simplesmente por ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Aninhe um ViewGroup no ViewGroup atual. |
ID da visualização
ViewId é um tipo enumerado usado para construir objetos View e ViewGroup.
ViewId.DOCS | Todos os tipos de documentos do Google Drive. |
ViewId.DOCS_IMAGES | Fotos do Google Drive. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Fotos e vídeos do Google Drive. |
ViewId.DOCS_VIDEOS | Vídeos do Google Drive |
ViewId.DOCUMENTS | Documentos do Google Drive |
ViewId.DRAWINGS | Desenhos do Google Drive. |
ViewId.FOLDERS | Pastas do Google Drive. |
ViewId.FORMS | Formulários do Google Drive |
ViewId.PDFS | Arquivos PDF armazenados no Google Drive. |
ViewId.PRESENTATIONS | Apresentações do Google Drive |
ViewId.SPREADSHEETS | Planilhas do Google Drive. |
Tipos de callback
Os tipos enumerados a seguir são encontrados nos dados de callback retornados pela API Google Picker.
Ação
Action é um tipo enumerado que representa a ação realizada pelo usuário para dispensar a caixa de diálogo. Esse valor está no campo Response.ACTION nos dados de callback.
Action.CANCEL | O usuário cancelou a caixa de diálogo do Google Picker. |
Action.PICKED | O usuário escolheu pelo menos um item. |
Documentos
Document é um tipo enumerado usado para transmitir informações sobre um item selecionado específico. Somente os campos relevantes para o item selecionado são retornados. Esse valor está no campo Response.DOCUMENTS nos dados de callback.
Document.DESCRIPTION | Uma descrição enviada pelo usuário do item selecionado. |
Document.DURATION | A duração de um vídeo selecionado. |
Document.EMBEDDABLE_URL | É um URL para este item, adequado para incorporação em uma página da Web. |
Document.ICON_URL | Um URL para um ícone desse item. |
Document.ID | ID do item selecionado. |
Document.IS_NEW | Retornará "true" se o item selecionado tiver sido enviado recentemente. |
Document.LAST_EDITED_UTC | É o carimbo de data/hora que descreve quando o item foi editado pela última vez. |
Document.MIME_TYPE | O tipo MIME deste item. |
Document.NAME | Nome do item. |
Document.NUM_CHILDREN | O número de filhos contidos neste item. Por exemplo, o número de arquivos na pasta selecionada. |
Document.PARENT_ID | O ID pai deste item. Por exemplo, a pasta que contém o arquivo. |
Document.SERVICE_ID | Um ServiceId que descreve o serviço em que o item foi selecionado. |
Document.THUMBNAILS | Uma matriz de Thumbnails que descreve os atributos de uma foto ou um vídeo. As miniaturas não são retornadas quando os itens selecionados pertencem ao Google Drive. |
Document.TYPE | O Type do item selecionado. |
Document.URL | Um URL para este item. |
Resposta
O Response é um tipo enumerado usado para transmitir informações sobre os itens selecionados pelo usuário.
Response.ACTION | Um tipo Action que representa a ação realizada pelo usuário para dispensar a caixa de diálogo. |
Response.DOCUMENTS | Uma matriz de Documents selecionada pelo usuário. |
Response.PARENTS | IDs das pastas mãe dos itens selecionados. Por exemplo, IDs das pastas mãe com os arquivos selecionados. |
Response.VIEW | O View de que o usuário selecionou esses itens. |
ID do serviço
ServiceId é um tipo enumerado usado para descrever o serviço em que o item foi selecionado. Esse valor está no campo Document.SERVICE_ID do Document selecionado.
ServiceId.DOCS | o Google Drive; |
miniatura
Thumbnail é um tipo enumerado usado para transmitir informações sobre uma foto ou um vídeo selecionado. Esse valor pode ser encontrado no campo Document.THUMBNAILS de um Document selecionado.
Thumbnail.HEIGHT | É a altura da foto ou do vídeo em pixels. |
Thumbnail.WIDTH | É a largura da foto ou do vídeo em pixels. |
Thumbnail.URL | Um URL para a foto ou o vídeo selecionado. |
tipo
Type é um tipo enumerado usado para categorizar o item selecionado. Esse valor pode ser encontrado no campo Document.TYPE de um Document selecionado.
Type.DOCUMENT | O item é um documento. |
Type.PHOTO | O item é uma foto. |
Type.VIDEO | O item é um vídeo. |