Cette page contient la liste des classes, des méthodes et des types énumérés disponibles dans l'API Google Picker. Tous ces éléments appartiennent à l'espace de noms google.picker.* Il existe deux types de classes et de types énumérés: ceux utilisés pour créer et configurer le sélecteur Google, et ceux qui sont renvoyés par le sélecteur Google une fois l'utilisateur sélectionné.
Types et classes de configuration
Les classes et les types énumérés suivants permettent de créer et de configurer Google Picker.
Vue de transfert de documents
Utilisez DocsUploadView pour importer des documents dans Google Drive.
DocsUploadView() | Constructeur. |
DocsUploadView.setIncludeFolders(boolean) | Permet à l'utilisateur de sélectionner un dossier de Google Drive pour l'importation. |
DocsUploadView.setParent(string) | Définit la destination d'importation sur le dossier spécifié. Cela remplace setIncludeFolders par "false". |
Vue Docs
DocsView est une sous-classe de View qui peut être utilisée pour les vues Google Drive.
DocsView(ViewId | undefined) | Constructeur. Le ViewId doit être l'une des vues Google Drive. La valeur par défaut est ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Affiche les Drive partagés et les fichiers qu'ils contiennent. Avant d'activer les Drive partagés, consultez la documentation de l'API Google Drive. |
DocsView.setIncludeFolders(boolean) | Afficher les dossiers dans les éléments de la vue. Ne pas combiner avec setOwnedByMe. Lorsque setIncludeFolders(true) est défini, setOwnedByMe est ignoré. |
DocsView.setSelectFolderEnabled(boolean) | Permet à l'utilisateur de sélectionner un dossier dans Google Drive. |
DocsView.setMode(DocsViewMode) | Sélectionne le mode d'affichage des documents utilisé par la vue. |
DocsView.setOwnedByMe(boolean | undefined) | Filtre les documents selon qu'ils appartiennent à l'utilisateur ou s'ils ont été partagés avec lui. Ne combinez pas ce paramètre avec setIncludeFolders. Lorsque setIncludeFolders(true) est défini, setOwnedByMe est ignoré. |
DocsView.setParent(string) | Définit le dossier parent initial à afficher. |
DocsView.setStarred(boolean) | Filtre les documents en fonction de leur suivi. |
Mode d'affichage des documents
DocsViewMode est un type énuméré permettant d'afficher des données dans une DocsView. Utilisez ces valeurs dans les appels à DocsView.setMode.
DocsViewMode.GRID | Affichez les documents dans une grille de vignettes. |
DocsViewMode.LIST | Affichez les documents dans une liste détaillée. |
Fonctionnalité
Feature est un type énuméré permettant d'activer ou de désactiver des fonctionnalités pour différentes vues. Utilisez ces valeurs dans les appels à PickerBuilder.enableFeature et PickerBuilder.disableFeature.
Feature.MINE_ONLY | Afficher uniquement les documents appartenant à l'utilisateur lors de l'affichage d'éléments provenant de Google Drive. |
Feature.MULTISELECT_ENABLED | Autoriser l'utilisateur à choisir plusieurs éléments. |
Feature.NAV_HIDDEN | Masquer le volet de navigation. Si le volet de navigation est masqué, les utilisateurs ne peuvent sélectionner que la première vue sélectionnée. |
Feature.SIMPLE_UPLOAD_ENABLED | Pour les transferts de photos, cette option permet de déterminer si la sélection par photo (par opposition à par album) est activée. |
Feature.SUPPORT_DRIVES |
Obsolète: les éléments des Drive partagés sont désormais inclus par défaut. Indique si les éléments du Drive partagé sont inclus dans les résultats. |
Sélecteur
Picker est l'objet de niveau supérieur représentant l'action de l'UI avec l'utilisateur. Ces objets ne sont pas créés directement, mais utilisent l'objet PickerBuilder.
Picker.isVisible() | Obtenir une valeur booléenne indiquant la visibilité actuelle du sélecteur |
Picker.setCallback(function(object)) | Spécifiez la méthode de rappel appelée lorsque l'utilisateur a sélectionné un article (ou annulé). |
Picker.setRelayUrl(string) | Spécifiez une URL de relais pour contourner les problèmes sur plusieurs domaines. |
Picker.setVisible(boolean) | Contrôlez la visibilité de l'objet sélecteur. |
Picker.dispose() | Supprime l'objet Picker. |
PickerBuilder
PickerBuilder permet de créer des objets Picker. Sauf indication contraire, le type de méthodes de retour ci-dessous est de type PickerBuilder, ce qui vous permet de chaîner un appel après l'autre. Consultez l'exemple de code Google Picker pour une utilisation courante.
PickerBuilder() | Constructeur. |
PickerBuilder.addView( | Ajoutez un View au volet de navigation. |
PickerBuilder.addViewGroup(ViewGroup) | Ajoutez un ViewGroup au volet de navigation de premier niveau. |
PickerBuilder.build() | Construisez l'objet Picker. L'objet Picker est renvoyé. |
PickerBuilder.disableFeature(Feature) | Désactiver une fonctionnalité de sélection |
PickerBuilder.enableFeature(Feature) | Activer une option de sélection |
PickerBuilder.getRelayUrl() | Obtenez l'URL du relais, utilisée pour gadgets.rpc. |
PickerBuilder.getTitle() | Obtenez le titre de la boîte de dialogue. |
PickerBuilder.hideTitleBar() | Désactiver l'affichage de la barre de titre Pour le réactiver, appelez setTitle avec un titre non vide ou non défini. |
PickerBuilder.isFeatureEnabled(Feature) | Vérifiez si l'outil de sélection Feature est activé. |
PickerBuilder.setAppId(string) | Définit l'ID de l'application Google Drive requis pour permettre à l'application d'accéder aux fichiers de l'utilisateur via l'API Google Drive. |
PickerBuilder.setCallback(method) | Définissez la méthode de rappel. Cette méthode est appelée lorsque l'utilisateur sélectionne des articles ou annule. La méthode de rappel reçoit un seul objet de rappel. La structure de l'objet de rappel est décrite dans le guide JSON. |
PickerBuilder.setDeveloperKey(string) | Définit la clé de l'API du navigateur obtenue à partir de la console Google APIs. Consultez le guide du développeur pour savoir comment obtenir la clé de l'API du navigateur. |
PickerBuilder.setDocument(document) | Définissez le document. |
PickerBuilder.setLocale(string) | Code de langue ISO 639. Si la langue n'est pas compatible, en-US est utilisé. Cette méthode constitue une alternative aux paramètres régionaux définis sur google.load(). Consultez le Guide du développeur pour obtenir la liste des paramètres régionaux pris en charge. |
PickerBuilder.setMaxItems(number) | Définit le nombre maximal d'éléments qu'un utilisateur peut sélectionner. |
PickerBuilder.setOAuthToken(string) | Définit un jeton OAuth à utiliser pour authentifier l'utilisateur actuel. Selon la portée du jeton, seules certaines vues affichent des données. Les champs d'application valides sont Google Docs, Drive, Photos et YouTube. |
PickerBuilder.setOrigin(string) | Définit l'origine de la boîte de dialogue "Sélecteur de Google". L'origine doit être définie sur le window.location.protocol + '//' + window.location.host de la page supérieure, si votre application s'exécute dans un iFrame. |
PickerBuilder.setRelayUrl(string) | Définissez l'URL de relais à utiliser pour gadgets.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Définir la liste des types MIME sélectionnables. Si vous devez indiquer plusieurs types MIME, séparez-les par une virgule. |
PickerBuilder.setSize() | Définissez la taille de la boîte de dialogue de votre choix. La boîte de dialogue est centrée automatiquement. Elle a une taille minimale de (566 350) et une taille maximale de (1 051 650). |
PickerBuilder.setTitle(string) | Définissez le titre de la boîte de dialogue. |
PickerBuilder.toUri() | Renvoie l'URI généré par ce compilateur. |
ResourceId
ResourceId est une classe statique permettant de générer des ID de ressources adaptés à l'API Google Documents List.
ResourceId.generate(Document) | Mapper un objet document à un ID de ressource |
Afficher
View est la classe de base abstraite des différentes classes View, par exemple DocsView.
View(ViewId) | Constructeur. |
View.getId() | Affiche l'ID ViewView de cette vue. |
View.setMimeTypes(string) | Définit les types MIME inclus dans la vue. Si vous devez indiquer plusieurs types MIME, séparez-les par une virgule. Si vous ne définissez pas de types MIME, tous les fichiers MIME sont affichés dans la vue. |
View.setQuery(string) | Pour les affichages impliquant des recherches, pré-renseignez la requête avec ces termes. |
ViewGroup
ViewGroup est un regroupement visuel de vues. L'élément racine du ViewGroup lui-même doit être un View.
ViewGroup(View | ViewId) | Un ViewGroup est un regroupement visuel de vues dans le volet de navigation. L'élément racine du ViewGroup lui-même doit être View. |
ViewGroup.addLabel(string) | Ajoutez un libellé à cet ViewGroup. |
ViewGroup.addView(ViewId | View) | Ajoutez une vue à l'ViewGroup. La View peut être représentée par un objet dérivé de view ou simplement par ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Imbriquer un ViewGroup dans la ViewGroup actuelle. |
ID de vue
ViewId est un type énuméré, utilisé pour construire des objets View et ViewGroup.
ViewId.DOCS | Tous les types de documents Google Drive. |
ViewId.DOCS_IMAGES | Photos Google Drive. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Photos et vidéos Google Drive. |
ViewId.DOCS_VIDEOS | Vidéos Google Drive. |
ViewId.DOCUMENTS | Documents Google Drive. |
ViewId.DRAWINGS | Dessins Google Drive. |
ViewId.FOLDERS | Dossiers Google Drive. |
ViewId.FORMS | Formulaires Google Drive. |
ViewId.PDFS | Fichiers PDF stockés dans Google Drive. |
ViewId.PRESENTATIONS | Présentations Google Drive. |
ViewId.SPREADSHEETS | Feuilles de calcul Google Drive. |
Types de rappel
Les types énumérés suivants sont présents dans les données de rappel renvoyées par l'API Google Picker.
Action
Action est un type énuméré représentant l'action effectuée par l'utilisateur pour fermer la boîte de dialogue. Cette valeur se trouve dans le champ Response.ACTION des données de rappel.
Action.CANCEL | L'utilisateur a annulé la boîte de dialogue Google Picker. |
Action.PICKED | L'utilisateur a choisi au moins un élément. |
Document
Document est un type d'énumération utilisé pour transmettre des informations sur un élément sélectionné. Seuls les champs pertinents pour l'élément sélectionné sont affichés. Cette valeur se trouve dans le champ Response.DOCUMENTS des données de rappel.
Document.DESCRIPTION | Description fournie par l'utilisateur pour l'élément sélectionné. |
Document.DURATION | Durée de la vidéo sélectionnée. |
Document.EMBEDDABLE_URL | URL de cet élément, adaptée à l'intégration dans une page Web. |
Document.ICON_URL | URL vers une icône pour cet élément. |
Document.ID | Identifiant de l'élément sélectionné. |
Document.IS_NEW | Renvoie la valeur "true" si l'élément sélectionné vient d'être importé. |
Document.LAST_EDITED_UTC | Horodatage indiquant la dernière modification de cet élément. |
Document.MIME_TYPE | Type MIME de l'article. |
Document.NAME | Nom de cet élément. |
Document.NUM_CHILDREN | Nombre d'enfants contenus dans cet élément. Par exemple, le nombre de fichiers dans le dossier sélectionné. |
Document.PARENT_ID | ID parent de cet élément. Par exemple, le dossier contenant ce fichier. |
Document.SERVICE_ID | ServiceId décrivant le service à partir duquel cet élément a été sélectionné. |
Document.THUMBNAILS | Tableau de valeurs Thumbnail décrivant les attributs d'une photo ou d'une vidéo. Aucune vignette ne s'affiche si les éléments sélectionnés appartiennent à Google Drive. |
Document.TYPE | Type de l'élément sélectionné. |
Document.URL | URL de cet élément. |
Réponse
Response est un type énuméré permettant de transmettre des informations sur les éléments sélectionnés par l'utilisateur.
Response.ACTION | Type Action représentant l'action effectuée par l'utilisateur pour fermer la boîte de dialogue. |
Response.DOCUMENTS | Tableau de Document sélectionnés par l'utilisateur. |
Response.PARENTS | ID des dossiers parents des éléments sélectionnés. (ID des dossiers parents dont les fichiers ont été sélectionnés, par exemple.) |
Response.VIEW | View : l'utilisateur a sélectionné ces éléments. |
identifiant de service
ServiceId est un type énuméré utilisé pour décrire le service à partir duquel l'élément a été sélectionné. Cette valeur se trouve dans le champ Document.SERVICE_ID du Document sélectionné.
ServiceId.DOCS | Dans Google Drive. |
thumbnail
Thumbnail est un type énuméré permettant de transmettre des informations sur une photo ou une vidéo sélectionnée. Cette valeur est indiquée dans le champ Document.THUMBNAILS de l'Document sélectionné.
Thumbnail.HEIGHT | Hauteur de la photo ou de la vidéo en pixels. |
Thumbnail.WIDTH | Largeur de la photo ou de la vidéo en pixels. |
Thumbnail.URL | URL de la photo ou de la vidéo sélectionnée. |
type
Type est un type énuméré permettant de classer l'élément sélectionné dans une catégorie. Cette valeur est indiquée dans le champ Document.TYPE de l'Document sélectionné.
Type.DOCUMENT | L'élément est un document. |
Type.PHOTO | L'élément est une photo. |
Type.VIDEO | L'élément est une vidéo. |