Ce service permet aux scripts de configurer et de créer des composants et des comportements de cartes et de widgets pour une UI. Les structures d'UI que vous créez avec ce service sont automatiquement disponibles sur les ordinateurs de bureau et les appareils mobiles. Vous n'avez donc pas besoin de développer des interfaces utilisateur distinctes pour les deux.
Classes
Nom | Brève description |
---|---|
Action | Action qui active l'interactivité dans les éléments de l'interface utilisateur. |
ActionResponse | Objet de réponse pouvant être renvoyé par une fonction de rappel (par exemple, un gestionnaire de réponses à un formulaire) pour effectuer une ou plusieurs actions sur le client. |
ActionResponseBuilder | Compilateur pour les objets ActionResponse . |
Attachment | Représente une pièce jointe créée par un module complémentaire. |
AuthorizationAction | Action d'autorisation qui redirige l'utilisateur vers AuthorizationUrl lorsqu'il clique dessus. |
AuthorizationException | Erreur pouvant être renvoyée pour déclencher l'affichage d'une carte d'autorisation auprès de l'utilisateur. |
BorderStyle | Classe représentant un style de bordure complet pouvant être appliqué aux widgets. |
BorderType | Énumération représentant les types de bordures pouvant être appliqués aux widgets. |
Button | Classe de base pour tous les boutons. |
ButtonSet | Contient un ensemble d'objets Button affichés sur une ligne. |
CalendarEventActionResponse | Représente une réponse qui modifie l'événement d'agenda en cours de modification par l'utilisateur en réaction à une action effectuée dans l'interface utilisateur, comme un clic sur un bouton. |
CalendarEventActionResponseBuilder | Compilateur pour les objets CalendarEventActionResponse . |
Card | Une fiche de contexte qui représente une seule vue de l'interface utilisateur. |
CardAction | Élément de menu cliquable ajouté au menu de l'en-tête de la carte. |
CardBuilder | Compilateur pour les objets Card . |
CardHeader | En-tête d'un élément Card . |
CardSection | Une section de fiche contient des groupes de widgets et permet de les séparer visuellement. |
CardService | CardService permet de créer des cartes génériques utilisées dans différents produits d'extensibilité Google, tels que les modules complémentaires Google Workspace. |
ComposeActionResponse | Objet de réponse pouvant être renvoyé par une méthode de rappel pour l'action de rédaction dans un module complémentaire Gmail. |
ComposeActionResponseBuilder | Compilateur pour les objets ComposeActionResponse . |
ComposedEmailType | Valeur d'énumération qui indique si l'e-mail composé est autonome ou sous forme de brouillon de réponse. |
ContentType | Valeur d'énumération qui spécifie le type de contenu du contenu généré par un UpdateDraftActionResponse . |
DatePicker | Champ de saisie permettant de saisir une date. |
DateTimePicker | Champ de saisie permettant aux utilisateurs de saisir une date et une heure. |
DecoratedText | Widget affichant du texte avec des décorations facultatives. |
DisplayStyle | Énumération qui définit le style d'affichage de la carte. |
Divider | Séparateur horizontal. |
DriveItemsSelectedActionResponse | Représente une réponse qui apporte des modifications à Drive lorsque des éléments Drive sont sélectionnés et en réaction à une action effectuée dans l'interface utilisateur (un clic sur un bouton, par exemple). |
DriveItemsSelectedActionResponseBuilder | Compilateur pour les objets DriveItemsSelectedActionResponse . |
EditorFileScopeActionResponse | Apporte des modifications à un éditeur, tel que Google Docs, Sheets ou Slides en réponse à une action effectuée dans l'interface utilisateur. |
EditorFileScopeActionResponseBuilder | Compilateur pour les objets EditorFileScopeActionResponse . |
FixedFooter | Pied de page fixe affiché en bas d'un Card de module complémentaire. |
Grid | Grille organisée pour afficher une collection d'éléments de grille. |
GridItem | Éléments avec lesquels les utilisateurs interagissent dans un widget de grille. |
GridItemLayout | Énumération qui définit le style d'image et de texte d'un élément GridItem. |
HorizontalAlignment | Énumération spécifiant l'alignement horizontal d'un widget. |
Icon | Des icônes prédéfinies pouvant être utilisées dans divers objets d'interface utilisateur, tels que les widgets ImageButton ou DecoratedText . |
IconImage | Une icône prédéfinie ou une icône provenant d'une URL avec un style de recadrage personnalisable. |
Image | Widget qui affiche une seule image. |
ImageButton | ImageButton avec une image affichée dessus. |
ImageComponent | Composant image qui peut être ajouté aux éléments de la grille. |
ImageCropStyle | Classe qui représente un style de recadrage pouvant être appliqué aux composants d'une image. |
ImageCropType | Énumération représentant les styles de recadrage appliqués aux composants de l'image. |
ImageStyle | Énumération qui définit un style de recadrage d'image. |
| Cette classe est obsolète. |
LoadIndicator | Type d'énumération qui spécifie le type de chargement ou d'indicateur de progression à afficher pendant le traitement d'une Action . |
Navigation | Objet d'assistance qui contrôle la navigation dans les fiches. |
Notification | Notification présentée à l'utilisateur en réponse à son interaction avec un élément d'interface utilisateur. |
OnClose | Énumération spécifiant l'action à effectuer lorsqu'une URL ouverte via un OpenLink est fermée. |
OpenAs | Énumération spécifiant comment ouvrir une URL. |
OpenLink | Représente une action permettant d'ouvrir un lien avec certaines options. |
SelectionInput | Champ de saisie permettant de choisir entre différentes options prédéfinies |
SelectionInputType | Type d'entrée de sélection. |
Suggestions | Suggestions de saisie semi-automatique pour compléter un widget TextInput . |
SuggestionsResponse | Objet de réponse pouvant être renvoyé à partir d'une fonction de rappel de suggestions. |
SuggestionsResponseBuilder | Compilateur pour les objets SuggestionsResponse . |
Switch | Élément d'interface utilisateur pouvant être activé ou désactivé. |
SwitchControlType | Type de commande de widget Switch . |
TextButton | Une TextButton avec un libellé de texte. |
TextButtonStyle | Énumération spécifiant le style de TextButton . |
TextInput | Widget de champ de saisie qui accepte la saisie de texte |
TextParagraph | Widget qui affiche le texte et accepte la mise en forme HTML de base. |
TimePicker | Champ de saisie permettant aux utilisateurs de saisir une heure. |
UniversalActionResponse | Objet de réponse pouvant être renvoyé par une méthode créant une action universelle. |
UniversalActionResponseBuilder | Compilateur pour les objets UniversalActionResponse . |
UpdateDraftActionResponse | Représente une action qui met à jour le brouillon d'e-mail en cours de modification par l'utilisateur. |
UpdateDraftActionResponseBuilder | Compilateur pour les objets UpdateDraftActionResponse . |
UpdateDraftBccRecipientsAction | Met à jour les destinataires en Cci d'un brouillon d'e-mail. |
UpdateDraftBodyAction | Met à jour le corps du brouillon de l'e-mail. |
UpdateDraftBodyType | Valeur d'énumération qui spécifie le type d'un UpdateDraftBodyAction . |
UpdateDraftCcRecipientsAction | Met à jour les destinataires en Cc d'un brouillon d'e-mail. |
UpdateDraftSubjectAction | Met à jour la ligne d'objet d'un brouillon d'e-mail. |
UpdateDraftToRecipientsAction | Met à jour le champ "À" des destinataires d'un brouillon d'e-mail. |
Widget | Classe de base pour tous les widgets pouvant être ajoutés à un Card . |
Action
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setFunctionName(functionName) | Action | Définit le nom de la fonction de rappel à appeler. |
setLoadIndicator(loadIndicator) | Action | Définit l'indicateur de chargement qui s'affiche pendant l'exécution de l'action. |
setParameters(parameters) | Action | Permet de transmettre des paramètres personnalisés à la fonction de rappel. |
ActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
ActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | ActionResponse | Crée la réponse d'action actuelle et la valide. |
setNavigation(navigation) | ActionResponseBuilder | Définit la réponse à une action Navigation . |
setNotification(notification) | ActionResponseBuilder | Définit la notification à afficher lorsque l'action est activée. |
setOpenLink(openLink) | ActionResponseBuilder | Définit l'URL vers laquelle accéder lorsque l'action est activée. |
setStateChanged(stateChanged) | ActionResponseBuilder | Définit un indicateur pour indiquer que cette action a modifié l'état des données existantes. |
Attachment
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setIconUrl(iconUrl) | Attachment | Définit l'URL de l'icône de la pièce jointe. |
setMimeType(mimeType) | Attachment | Définit le type MIME de la pièce jointe. |
setResourceUrl(resourceUrl) | Attachment | Définit l'URL de la ressource pour le rattachement. |
setTitle(title) | Attachment | Définit le titre de la pièce jointe. |
AuthorizationAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAuthorizationUrl(authorizationUrl) | AuthorizationAction | Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation. |
AuthorizationException
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
setAuthorizationUrl(authUrl) | AuthorizationException | Définit l'URL d'autorisation vers laquelle l'utilisateur est redirigé à partir de l'invite d'autorisation. |
setCustomUiCallback(callback) | AuthorizationException | Nom d'une fonction à appeler pour générer une invite d'autorisation personnalisée. |
setResourceDisplayName(name) | AuthorizationException | Définit le nom que l'utilisateur voit lorsqu'il demande une autorisation. |
throwException() | void | Déclenche cette exception. |
BorderStyle
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setCornerRadius(radius) | BorderStyle | Définit l'arrondi d'angle de la bordure (par exemple, 8). |
setStrokeColor(color) | BorderStyle | Définit la couleur de la bordure. |
setType(type) | BorderStyle | Définit le type de bordure. |
BorderType
Propriétés
Propriété | Type | Description |
---|---|---|
NO_BORDER | Enum | Aucun style de bordure. |
STROKE | Enum | Style de bordure du trait. |
Button
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAuthorizationAction(action) | Button | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) | Button | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setOnClickAction(action) | Button | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | Button | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | Button | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
ButtonSet
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addButton(button) | ButtonSet | Ajoute un bouton. |
CalendarEventActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
CalendarEventActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addAttachments(attachments) | CalendarEventActionResponseBuilder | Indique que la réponse doit ajouter les pièces jointes à l'événement d'agenda lorsque l'action associée dans l'interface utilisateur est effectuée. |
addAttendees(emails) | CalendarEventActionResponseBuilder | Indique que la réponse doit ajouter les participants indiqués à l'événement d'agenda lorsque l'action associée dans l'interface utilisateur est effectuée. |
build() | CalendarEventActionResponse | Crée la réponse d'action d'événement d'agenda actuelle et la valide. |
setConferenceData(conferenceData) | CalendarEventActionResponseBuilder | Indique que la réponse doit définir les données de conférence indiquées sur l'événement d'agenda lorsque l'action associée dans l'interface utilisateur est effectuée. |
Card
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
CardAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAuthorizationAction(action) | CardAction | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) | CardAction | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setOnClickAction(action) | CardAction | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | CardAction | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | CardAction | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
setText(text) | CardAction | Définit le texte du menu pour cette action. |
CardBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addCardAction(cardAction) | CardBuilder | Ajoute un CardAction à cette fiche. |
addSection(section) | CardBuilder | Ajoute une section à cette fiche. |
build() | Card | Crée la carte actuelle et la valide. |
setDisplayStyle(displayStyle) | CardBuilder | Définit le style d'affichage de cette fiche. |
setFixedFooter(fixedFooter) | CardBuilder | Définit un pied de page fixe pour cette fiche. |
setHeader(cardHeader) | CardBuilder | Définit l'en-tête de cette fiche. |
setName(name) | CardBuilder | Définit le nom de cette carte. |
setPeekCardHeader(peekCardHeader) | CardBuilder | Définit l'en-tête de la fiche d'aperçu. |
CardHeader
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setImageAltText(imageAltText) | CardHeader | Définit le texte alternatif de l'image d'en-tête. |
setImageStyle(imageStyle) | CardHeader | Définit le recadrage de l'icône dans l'en-tête de la fiche. |
setImageUrl(imageUrl) | CardHeader | Définit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données. |
setSubtitle(subtitle) | CardHeader | Définit le sous-titre de l'en-tête de la carte. |
setTitle(title) | CardHeader | Définit le titre de l'en-tête de la carte. |
CardSection
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addWidget(widget) | CardSection | Ajoute le widget donné à cette section. |
setCollapsible(collapsible) | CardSection | Détermine si la section peut être réduite. |
setHeader(header) | CardSection | Définit l'en-tête de la section. |
setNumUncollapsibleWidgets(numUncollapsibleWidgets) | CardSection | Définit le nombre de widgets qui restent affichés lorsque cette section est réduite. |
CardService
Propriétés
Propriété | Type | Description |
---|---|---|
BorderType | BorderType | Énumération BorderType . |
ComposedEmailType | ComposedEmailType | Énumération ComposedEmailType . |
ContentType | ContentType | Énumération ContentType . |
GridItemLayout | GridItemLayout | Énumération GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | Énumération HorizontalAlignment . |
Icon | Icon | Énumération Icon . |
ImageCropType | ImageCropType | Énumération ImageCropType . |
ImageStyle | ImageStyle | Énumération ImageStyle . |
LoadIndicator | LoadIndicator | Énumération LoadIndicator . |
OnClose | OnClose | Énumération OnClose . |
OpenAs | OpenAs | Énumération OpenAs . |
SelectionInputType | SelectionInputType | Énumération SelectionInputType . |
TextButtonStyle | TextButtonStyle | Énumération TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | Énumération UpdateDraftBodyType . |
Méthodes
ComposeActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
ComposeActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | ComposeActionResponse | Crée la réponse d'action Compose actuelle et la valide. |
setGmailDraft(draft) | ComposeActionResponseBuilder | Définit le brouillon GmailMessage créé à l'aide de GmailMessage.createDraftReply(body) ou de fonctions similaires. |
ComposedEmailType
Propriétés
Propriété | Type | Description |
---|---|---|
REPLY_AS_DRAFT | Enum | Brouillon de réponse à un autre message |
STANDALONE_DRAFT | Enum | Brouillon de message autonome. |
ContentType
Propriétés
Propriété | Type | Description |
---|---|---|
TEXT | Enum | Indique que le contenu généré est en texte brut. |
MUTABLE_HTML | Enum | Indique que le contenu généré est au format HTML. |
IMMUTABLE_HTML | Enum | Indique que le contenu généré est au format HTML, mais qu'il ne peut pas être modifié après sa création. |
DatePicker
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setFieldName(fieldName) | DatePicker | Définit le nom de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setOnChangeAction(action) | DatePicker | Définit une Action que le script exécute chaque fois que l'entrée du sélecteur change. |
setTitle(title) | DatePicker | Définit le titre affiché au-dessus du champ de saisie. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Définit la valeur préremplie à définir dans le champ de saisie. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Définit la valeur préremplie à définir dans le champ de saisie. |
DateTimePicker
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setFieldName(fieldName) | DateTimePicker | Définit le nom de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setOnChangeAction(action) | DateTimePicker | Définit une Action que le script exécute chaque fois que l'entrée du sélecteur change. |
setTimeZoneOffsetInMins(timeZoneOffsetMins) | DateTimePicker | Définit le nombre de minutes de décalage du fuseau horaire par rapport à UTC. |
setTitle(title) | DateTimePicker | Définit le titre affiché au-dessus du champ de saisie. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Définit la valeur préremplie à définir dans le champ de saisie. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Définit la valeur préremplie à définir dans le champ de saisie. |
DecoratedText
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setBottomLabel(text) | DecoratedText | Définit le texte du libellé à utiliser comme clé et s'affiche sous le contenu textuel. |
setButton(button) | DecoratedText | Définit le Button qui s'affiche à droite du texte. |
setComposeAction(action, composedEmailType) | DecoratedText | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setEndIcon(endIcon) | DecoratedText | Définit la IconImage facultative qui s'affiche à droite du contenu. |
setOnClickAction(action) | DecoratedText | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | DecoratedText | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | DecoratedText | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
setStartIcon(startIcon) | DecoratedText | Définit la IconImage facultative à afficher avant le contenu textuel. |
setSwitchControl(switchToSet) | DecoratedText | Définit l'Switch qui s'affiche à droite du contenu. |
setText(text) | DecoratedText | Définit le texte à utiliser comme valeur. |
setTopLabel(text) | DecoratedText | Définit le texte du libellé à utiliser comme clé et s'affiche au-dessus du contenu textuel. |
setWrapText(wrapText) | DecoratedText | Détermine si le texte de la valeur doit être affiché sur une ou plusieurs lignes. |
DisplayStyle
Propriétés
Propriété | Type | Description |
---|---|---|
PEEK | Enum | Affichez l'en-tête de la fiche en bas du contenu complémentaire par-dessus le contenu existant. |
REPLACE | Enum | Affichez la fiche en remplaçant le contenu existant. |
Divider
DriveItemsSelectedActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
DriveItemsSelectedActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | DriveItemsSelectedActionResponse | Crée la réponse d'action Drive actuelle. |
requestFileScope(itemId) | DriveItemsSelectedActionResponseBuilder | Indique que la réponse demande une portée du fichier pour l'élément contextuel dans Drive. |
EditorFileScopeActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
EditorFileScopeActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | EditorFileScopeActionResponse | Crée la réponse d'action Editor actuelle. |
requestFileScopeForActiveDocument() | EditorFileScopeActionResponseBuilder | Demande le niveau d'accès drive.file pour le document Editor actif actuel. |
FixedFooter
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setPrimaryButton(button) | FixedFooter | Définissez le bouton principal dans le pied de page fixe. |
setSecondaryButton(button) | FixedFooter | Placez le bouton secondaire dans le pied de page fixe. |
Grid
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addItem(gridItem) | Grid | Ajoute un nouvel élément à la grille. |
setAuthorizationAction(action) | Grid | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setBorderStyle(borderStyle) | Grid | Définit le style de bordure appliqué à chaque élément de la grille. |
setComposeAction(action, composedEmailType) | Grid | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setNumColumns(numColumns) | Grid | Nombre de colonnes à afficher dans la grille. |
setOnClickAction(action) | Grid | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | Grid | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | Grid | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
setTitle(title) | Grid | Définit le texte du titre de la grille. |
GridItem
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setIdentifier(id) | GridItem | Définit l'identifiant de l'élément de grille. |
setImage(image) | GridItem | Définit l'image de cet élément de grille. |
setLayout(layout) | GridItem | Définit la mise en page du texte et des images pour l'élément de la grille. |
setSubtitle(subtitle) | GridItem | Définit le sous-titre de l'élément de la grille. |
setTextAlignment(alignment) | GridItem | Définit l'alignement horizontal de l'élément de grille. |
setTitle(title) | GridItem | Définit le titre de l'élément de la grille. |
GridItemLayout
Propriétés
Propriété | Type | Description |
---|---|---|
TEXT_BELOW | Enum | Le titre et le sous-titre sont affichés sous l'image de l'élément de la grille. |
TEXT_ABOVE | Enum | Le titre et le sous-titre sont affichés au-dessus de l'image de l'élément de la grille. |
HorizontalAlignment
Propriétés
Propriété | Type | Description |
---|---|---|
START | Enum | Alignez le widget au début du côté de la phrase. |
CENTER | Enum | Alignez le widget au centre. |
END | Enum | Alignez le widget à la fin de la phrase. |
Icon
Propriétés
Propriété | Type | Description |
---|---|---|
NONE | Enum | Aucune icône. |
AIRPLANE | Enum | ![]() |
BOOKMARK | Enum | ![]() |
BUS | Enum | ![]() |
CAR | Enum | ![]() |
CLOCK | Enum | ![]() |
CONFIRMATION_NUMBER_ICON | Enum | ![]() |
DOLLAR | Enum | ![]() |
DESCRIPTION | Enum | ![]() |
EMAIL | Enum | ![]() |
EVENT_PERFORMER | Enum | ![]() |
EVENT_SEAT | Enum | ![]() |
FLIGHT_ARRIVAL | Enum | ![]() |
FLIGHT_DEPARTURE | Enum | ![]() |
HOTEL | Enum | ![]() |
HOTEL_ROOM_TYPE | Enum | ![]() |
INVITE | Enum | ![]() |
MAP_PIN | Enum | ![]() |
MEMBERSHIP | Enum | ![]() |
MULTIPLE_PEOPLE | Enum | ![]() |
OFFER | Enum | ![]() |
PERSON | Enum | ![]() |
PHONE | Enum | ![]() |
RESTAURANT_ICON | Enum | ![]() |
SHOPPING_CART | Enum | ![]() |
STAR | Enum | ![]() |
STORE | Enum | ![]() |
TICKET | Enum | ![]() |
TRAIN | Enum | ![]() |
VIDEO_CAMERA | Enum | ![]() |
VIDEO_PLAY | Enum | ![]() |
IconImage
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAltText(altText) | IconImage | Définit le texte alternatif de l'URL utilisée pour l'accessibilité. |
setIcon(icon) | IconImage | Définit l'icône prédéfinie si l'URL n'est pas définie. |
setIconUrl(url) | IconImage | Définit l'URL de l'icône si celle-ci n'est pas définie. |
setImageCropType(imageCropType) | IconImage | Définit le style de recadrage de l'image. |
Image
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAltText(altText) | Image | Définit le texte alternatif de l'image pour l'accessibilité. |
setAuthorizationAction(action) | Image | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) | Image | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setImageUrl(url) | Image | Définit l'image à utiliser en fournissant son URL ou sa chaîne de données. |
setOnClickAction(action) | Image | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | Image | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | Image | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
ImageButton
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAltText(altText) | ImageButton | Définit le texte alternatif du bouton pour l'accessibilité. |
setAuthorizationAction(action) | ImageButton | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) | ImageButton | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setIcon(icon) | ImageButton | Définit une Icon prédéfinie à afficher sur le bouton. |
setIconUrl(url) | ImageButton | Définit l'URL d'une image à utiliser comme icône de ce bouton. |
setOnClickAction(action) | ImageButton | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | ImageButton | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | ImageButton | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
ImageComponent
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAltText(altText) | ImageComponent | Définit le texte alternatif de l'image. |
setBorderStyle(borderStyle) | ImageComponent | Définit le style de bordure appliqué à l'image. |
setCropStyle(imageCropStyle) | ImageComponent | Définit le style de recadrage de l'image. |
setImageUrl(url) | ImageComponent | Définit l'URL de l'image. |
ImageCropStyle
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAspectRatio(ratio) | ImageCropStyle | Définit le format à utiliser si le type de recadrage est RECTANGLE_CUSTOM . |
setImageCropType(type) | ImageCropStyle | Définit le type de recadrage de l'image. |
ImageCropType
Propriétés
Propriété | Type | Description |
---|---|---|
SQUARE | Enum | Style de recadrage carré. |
CIRCLE | Enum | Style de recadrage en forme de cercle |
RECTANGLE_CUSTOM | Enum | Style de recadrage de forme rectangulaire avec ratio personnalisé |
RECTANGLE_4_3 | Enum | Style de recadrage de forme rectangulaire au format 4:3 |
ImageStyle
Propriétés
Propriété | Type | Description |
---|---|---|
SQUARE | Enum | Pas de recadrage. |
CIRCLE | Enum | Recadrez l'image pour lui donner un cercle. |
KeyValue
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAuthorizationAction(action) |
| Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) |
| Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setOnClickAction(action) |
| Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) |
| Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) |
| Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
LoadIndicator
Propriétés
Propriété | Type | Description |
---|---|---|
SPINNER | Enum | Utilisez une icône de chargement. |
NONE | Enum | N'utilisez pas d'indicateur. |
Navigation
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
popCard() | Navigation | Affiche une carte de la pile de navigation. |
popToNamedCard(cardName) | Navigation | Affiche la carte spécifiée à partir de son nom. |
popToRoot() | Navigation | Ajoute la pile de cartes à la carte racine. |
printJson() | String | Affiche la représentation JSON de cet objet. |
pushCard(card) | Navigation | Transfère la carte donnée dans la pile. |
updateCard(card) | Navigation | Remplacement sur place de la carte actuelle. |
Notification
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setText(text) | Notification | Définit le texte à afficher dans la notification. |
OnClose
Propriétés
Propriété | Type | Description |
---|---|---|
NOTHING | Enum | Ne rien faire à la fermeture |
RELOAD | Enum | Il actualise le module complémentaire lorsque la fenêtre se ferme. |
OpenAs
Propriétés
Propriété | Type | Description |
---|---|---|
FULL_SIZE | Enum | Ouvrir dans une fenêtre ou un onglet complet. |
OVERLAY | Enum | La bannière s'ouvre en superposition, par exemple dans une fenêtre pop-up. |
OpenLink
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setOnClose(onClose) | OpenLink | Définit le comportement de l'action d'URL lorsque la fenêtre ou l'onglet de l'URL est fermé. |
setOpenAs(openAs) | OpenLink | Définit le comportement de l'URL lorsqu'elle est ouverte. |
setUrl(url) | OpenLink | Définit l'URL à ouvrir. |
SelectionInput
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addItem(text, value, selected) | SelectionInput | Ajoute un nouvel élément pouvant être sélectionné. |
setFieldName(fieldName) | SelectionInput | Définit la clé qui identifie cette entrée de sélection dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setOnChangeAction(action) | SelectionInput | Définit une Action à exécuter chaque fois que l'entrée de sélection change. |
setTitle(title) | SelectionInput | Définit le titre à afficher devant le champ de saisie. |
setType(type) | SelectionInput | Définit le type de cette entrée. |
SelectionInputType
Propriétés
Propriété | Type | Description |
---|---|---|
CHECK_BOX | Enum | Style de saisie de la case à cocher. |
RADIO_BUTTON | Enum | Style d'entrée via bouton radio. |
DROPDOWN | Enum | Style d'entrée pour la sélection du menu déroulant |
Suggestions
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addSuggestion(suggestion) | Suggestions | Ajoutez une suggestion de texte. |
addSuggestions(suggestions) | Suggestions | Ajoutez une liste de suggestions de texte. |
SuggestionsResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
SuggestionsResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | SuggestionsResponse | Crée la réponse de suggestion actuelle et la valide. |
setSuggestions(suggestions) | SuggestionsResponseBuilder | Définit les suggestions utilisées pour la saisie semi-automatique dans les champs de texte. |
Switch
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setControlType(controlType) | Switch | Définit le type de commande du contacteur. |
setFieldName(fieldName) | Switch | Définit la clé qui identifie ce contacteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setOnChangeAction(action) | Switch | Définit l'action à effectuer lorsque le bouton est activé. |
setSelected(selected) | Switch | Détermine si ce bouton bascule doit être sélectionné ou non au départ. |
setValue(value) | Switch | Définit la valeur envoyée en tant que saisie de formulaire lorsque ce bouton est activé. |
SwitchControlType
Propriétés
Propriété | Type | Description |
---|---|---|
SWITCH | Enum | Commande d'activation/désactivation stylisée pour un widget de commutateur. |
CHECK_BOX | Enum | Commande de style case à cocher pour un widget Switch (Bouton bascule) |
TextButton
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setAltText(altText) | TextButton | Définit le texte alternatif du bouton pour l'accessibilité. |
setAuthorizationAction(action) | TextButton | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setBackgroundColor(backgroundColor) | TextButton | Définit la couleur d'arrière-plan du bouton TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setDisabled(disabled) | TextButton | Détermine si le bouton est désactivé. |
setOnClickAction(action) | TextButton | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | TextButton | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | TextButton | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
setText(text) | TextButton | Définit le texte à afficher sur le bouton. |
setTextButtonStyle(textButtonStyle) | TextButton | Définit le style du bouton. |
TextButtonStyle
Propriétés
Propriété | Type | Description |
---|---|---|
TEXT | Enum | Bouton de texte normal sur fond clair. |
FILLED | Enum | Bouton de texte sur fond coloré. |
TextInput
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setFieldName(fieldName) | TextInput | Définit la clé qui identifie cette entrée de texte dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setHint(hint) | TextInput | Définit une indication pour le texte saisi. |
setMultiline(multiline) | TextInput | Détermine si le texte d'entrée s'affiche sur une ou plusieurs lignes. |
setOnChangeAction(action) | TextInput | Définit une action à exécuter chaque fois que l'entrée de texte change. |
setSuggestions(suggestions) | TextInput | Définit les suggestions de saisie semi-automatique dans le champ de texte. |
setSuggestionsAction(suggestionsAction) | TextInput | Définit l'action de rappel pour récupérer des suggestions basées sur l'entrée utilisateur pour la saisie semi-automatique. |
setTitle(title) | TextInput | Définit le titre à afficher au-dessus du champ de saisie. |
setValue(value) | TextInput | Définit la valeur préremplie à définir dans le champ de saisie. |
TextParagraph
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setText(text) | TextParagraph | Définit le texte du paragraphe. |
TimePicker
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setFieldName(fieldName) | TimePicker | Définit le nom de champ qui identifie ce sélecteur dans l'objet événement généré en cas d'interaction avec l'interface utilisateur. |
setHours(hours) | TimePicker | Définit la valeur des heures préremplies à définir dans le champ de saisie. |
setMinutes(minutes) | TimePicker | Définit la valeur préremplie du nombre de minutes à définir dans le champ de saisie. |
setOnChangeAction(action) | TimePicker | Définit une Action que le script exécute chaque fois que l'entrée du sélecteur change. |
setTitle(title) | TimePicker | Définit le titre affiché au-dessus du champ de saisie. |
UniversalActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
UniversalActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | UniversalActionResponse | Crée la réponse d'action universelle actuelle et la valide. |
displayAddOnCards(cardObjects) | UniversalActionResponseBuilder | Affiche le module complémentaire avec les fiches spécifiées. |
setOpenLink(openLink) | UniversalActionResponseBuilder | Définit l'URL à ouvrir lorsque l'action universelle est sélectionnée. |
UpdateDraftActionResponse
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
printJson() | String | Affiche la représentation JSON de cet objet. |
UpdateDraftActionResponseBuilder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | UpdateDraftActionResponse | Crée la réponse à l'action brouillon de mise à jour actuelle et la valide. |
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction) | UpdateDraftActionResponseBuilder | Définit une action qui met à jour les destinataires d'un brouillon en Cci. |
setUpdateDraftBodyAction(updateDraftBodyAction) | UpdateDraftActionResponseBuilder | Définissez une action qui met à jour le corps d'un brouillon d'e-mail. |
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction) | UpdateDraftActionResponseBuilder | Définit une action qui met à jour les destinataires en Cc d'un brouillon. |
setUpdateDraftSubjectAction(updateDraftSubjectAction) | UpdateDraftActionResponseBuilder | Définit une action qui met à jour l'objet d'un brouillon. |
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction) | UpdateDraftActionResponseBuilder | Définit une action qui met à jour le champ "À" des destinataires d'un brouillon. |
UpdateDraftBccRecipientsAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addUpdateBccRecipients(bccRecipientEmails) | UpdateDraftBccRecipientsAction | Met à jour les destinataires en Cci d'un brouillon d'e-mail. |
UpdateDraftBodyAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addUpdateContent(content, contentType) | UpdateDraftBodyAction | Ajoute le contenu spécifié au brouillon du corps du texte. |
setUpdateType(updateType) | UpdateDraftBodyAction | Définit l'élément UpdateDraftBodyType de cette action de mise à jour dans le corps du brouillon. |
UpdateDraftBodyType
Propriétés
Propriété | Type | Description |
---|---|---|
IN_PLACE_INSERT | Enum | Par défaut. |
INSERT_AT_START | Enum | Les actions de mise à jour insèrent du contenu au début du corps du message. |
INSERT_AT_END | Enum | Les actions de mise à jour insèrent du contenu à la fin du corps du message. |
UpdateDraftCcRecipientsAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addUpdateCcRecipients(ccRecipientEmails) | UpdateDraftCcRecipientsAction | Met à jour les destinataires en Cc d'un brouillon d'e-mail. |
UpdateDraftSubjectAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addUpdateSubject(subject) | UpdateDraftSubjectAction | Met à jour la ligne d'objet d'un brouillon d'e-mail. |
UpdateDraftToRecipientsAction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addUpdateToRecipients(toRecipientEmails) | UpdateDraftToRecipientsAction | Met à jour le champ "À" des destinataires d'un brouillon d'e-mail. |