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 qui sont utilisés pour créer et configurer le sélecteur Google, et ceux qui sont renvoyés par le sélecteur Google une fois que l'utilisateur a sélectionné un élément.
Types et classes de configuration
Les classes et les types énumérés suivants sont utilisés pour créer et configurer le sélecteur Google.
DocsUploadView
Utilisez DocsUploadView pour importer des documents dans Google Drive.
DocsUploadView() | Constructeur. |
DocsUploadView.setIncludeFolders(boolean) | Permet à l'utilisateur de sélectionner un dossier Google Drive dans lequel importer les données. |
DocsUploadView.setParent(string) | Définit la destination de l'importation sur le dossier spécifié. Cette valeur remplace setIncludeFolders par "false". |
DocsView
DocsView est une sous-classe de View qui peut être utilisée pour les vues Google Drive.
DocsView(ViewId | undefined) | Constructeur. ViewId doit faire partie 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 l'activation, reportez-vous à la documentation de l'API Google Drive sur l'activation des Drive partagés. |
DocsView.setIncludeFolders(boolean) | Afficher les dossiers dans la vue des éléments 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 utilisé par la vue pour afficher les documents. |
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 selon qu'ils sont ou non suivis par l'utilisateur. |
DocsViewMode
DocsViewMode est un type énuméré permettant d'afficher des données dans un affichage DocsView. Utilisez ces valeurs dans les appels à DocsView.setMode.
DocsViewMode.GRID | Afficher les documents sous forme de grille de vignettes. |
DocsViewMode.LIST | Affichez les documents sous forme de liste détaillée. |
Sélection
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 dont l'utilisateur est propriétaire lorsque les éléments de Google Drive sont affichés. |
Feature.MULTISELECT_ENABLED | Autoriser l'utilisateur à choisir plusieurs éléments |
Feature.NAV_HIDDEN | Masquez le volet de navigation. Si le volet de navigation est masqué, les utilisateurs ne peuvent sélectionner que la première vue choisie. |
Feature.SIMPLE_UPLOAD_ENABLED | Pour les photos importées, contrôle si la sélection par photo (et non 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 qui représente l'action de l'interface utilisateur avec l'utilisateur. Ces objets ne sont pas créés directement, mais utilisent à la place l'objet PickerBuilder.
Picker.isVisible() | Obtenir une valeur booléenne indiquant la visibilité actuelle du "Picker" |
Picker.setCallback(function(object)) | Spécifiez la méthode de rappel appelée chaque fois que l'utilisateur sélectionne un article (ou l'annule). |
Picker.setRelayUrl(string) | Spécifiez une URL de relais pour contourner les problèmes entre domaines. |
Picker.setVisible(boolean) | Contrôle la visibilité de l'objet Picker. |
Picker.dispose() | Supprime l'objet Picker. |
PickerBuilder
PickerBuilder permet de créer des objets Picker. Sauf indication contraire, le type renvoyé des méthodes ci-dessous est de type PickerBuilder, ce qui vous permet d'enchaîner les appels. Consultez l'exemple de code du sélecteur Google pour une utilisation standard.
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() | Créez l'objet Picker. L'objet Picker est renvoyé. |
PickerBuilder.disableFeature(Feature) | Désactiver une fonctionnalité de sélecteur |
PickerBuilder.enableFeature(Feature) | Activez une fonctionnalité de sélecteur. |
PickerBuilder.getRelayUrl() | Permet d'obtenir l'URL de relais utilisée pour gadgets.rpc. |
PickerBuilder.getTitle() | Permet d'obtenir 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 un sélecteur Feature est activé. |
PickerBuilder.setAppId(string) | Définit l'ID de l'application Google Drive nécessaire 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 les 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é API du navigateur obtenue à partir de la console Google APIs. Consultez le Guide du développeur pour savoir comment obtenir la clé API du navigateur. |
PickerBuilder.setDocument(document) | Configurez le document. |
PickerBuilder.setLocale(string) | Code de langue ISO 639. Si la langue n'est pas prise en charge, l'anglais américain est utilisé. Cette méthode offre une alternative à la définition des paramètres régionaux au moment de google.load(). Pour connaître la liste des paramètres régionaux compatibles, consultez le Guide du développeur. |
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 le champ d'application du jeton, seules certaines vues affichent des données. Les champs d'application valides sont Google Docs et Drive. |
PickerBuilder.setOrigin(string) | Définit l'origine de la boîte de dialogue du sélecteur Google. Si votre application s'exécute dans un iFrame, l'origine doit être définie sur le window.location.protocol + '//' + window.location.host de la page supérieure. |
PickerBuilder.setRelayUrl(string) | Définit l'URL de relais utilisée pour gadgets.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Définissez la liste des types MIME sélectionnables. Utilisez des virgules pour séparer les types MIME si plusieurs sont requis. |
PickerBuilder.setSize() | Définissez la taille de boîte de dialogue souhaitée. La boîte de dialogue est centrée automatiquement. Sa taille minimale est de (566 350) et sa 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) | Mappez un objet Document avec 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() | Renvoie le ViewId de cette vue. |
View.setMimeTypes(string) | Définit les types MIME inclus dans la vue. Utilisez des virgules pour séparer les types MIME si plusieurs sont requis. Si vous ne définissez pas de types MIME, les fichiers de tous les types MIME s'affichent dans la vue. |
View.setQuery(string) | Pour les vues impliquant des recherches, renseignez ces termes dans la requête de recherche. |
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 des vues dans le volet de navigation. L'élément racine du ViewGroup lui-même doit être View. |
ViewGroup.addLabel(string) | Ajoutez un libellé à ce ViewGroup. |
ViewGroup.addView(ViewId | View) | Ajoutez une vue au ViewGroup. Le View peut être représenté par un objet dérivé de view ou simplement par ViewId. |
ViewGroup.addViewGroup(ViewGroup) | Imbriquez une ViewGroup dans la ViewGroup actuelle. |
ViewId
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 | des 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 figurent 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 du sélecteur Google. |
Action.PICKED | L'utilisateur a choisi au moins un élément. |
Document
Document est un type énuméré utilisé pour transmettre des informations sur un élément sélectionné spécifique. Seuls les champs pertinents pour l'élément sélectionné sont renvoyés. Cette valeur se trouve dans le champ Response.DOCUMENTS des données de rappel.
Document.DESCRIPTION | Description de l'élément sélectionné fournie par un utilisateur. |
Document.DURATION | Durée d'une vidéo sélectionnée. |
Document.EMBEDDABLE_URL | URL de cet élément pouvant être intégrée à une page Web. |
Document.ICON_URL | URL d'une icône pour cet élément. |
Document.ID | ID 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 | Code temporel indiquant la date de la dernière modification de cet élément. |
Document.MIME_TYPE | Type MIME de cet élément. |
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 | Identifiant parent de cet élément. Par exemple, le dossier contenant ce fichier. |
Document.SERVICE_ID | ServiceId décrivant le service dans lequel 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. Les vignettes ne s'affichent pas 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é utilisé pour 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 d'éléments 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 | Les View dans lesquels l'utilisateur a sélectionné ces éléments. |
ID du service
ServiceId est un type énuméré utilisé pour décrire le service dans lequel 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é utilisé pour transmettre des informations sur une photo ou une vidéo sélectionnée. Cette valeur se trouve dans le champ Document.THUMBNAILS d'un 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é utilisé pour classer l'élément sélectionné. Cette valeur se trouve dans le champ Document.TYPE d'un Document sélectionné.
Type.DOCUMENT | L'élément est un document. |
Type.PHOTO | Il s'agit d'une photo. |
Type.VIDEO | L'élément est une vidéo. |