AddOns Response Service

Service de réponse aux modules complémentaires

Ce service permet aux scripts de configurer et de créer des modules complémentaires Google Workspace.

Classes

NomBrève description
AccessoryWidget
ActionAction que les modules complémentaires Google Workspace qui étendent Google Workspace Studio peuvent utiliser pour afficher une nouvelle fiche.
ActionResponse
ActionResponseBuilder
AddOnsResponseServiceAddOnsResponseService permet de créer des réponses pour les modules complémentaires Google Workspace.
AddonComposeUiActionResponse
AddonComposeUiActionResponseBuilder
AddonComposeUiActionType
Attachment
BasicDataTypeÉnumération qui représente les types de données génériques de base.
CalendarEventActionResponse
CalendarEventActionResponseBuilder
ChatDataActionsResponseBuilder
ChatMessage
ColorObjet Color représentant une couleur dans l'espace colorimétrique RVBA.
ComposeActionResponse
ComposeActionResponseBuilder
ComposedEmailType
ContentType
CreateMessageAction
DataActionsResponse
DataTypeUn DataType permet de définir le type d'une variable.
DriveItemsSelectedActionResponse
DriveItemsSelectedActionResponseBuilder
DynamicResourceDefinitionUne DynamicResourceDefinition est un élément de base pour un ResourceFieldsDefinitionRetrievedAction. Elle peut contenir un ou plusieurs nombres de ResourceField pour définir de manière dynamique le nombre de variables de sortie fournies par une étape dans Google Workspace Studio.
EditorFileScopeActionResponse
EditorFileScopeActionResponseBuilder
EndNavigation
ErrorActionabilityÉnumération représentant l'actionnabilité de l'erreur.
ErrorRetryabilityÉnumération qui représente la possibilité de réessayer l'appel d'action en cas d'erreur.
FontWeightÉnumération représentant l'épaisseur de la police du texte stylisé.
HostAppActionHostAppAction est un type d'action géré par des applications hôtes individuelles.
HyperlinkÉlément Hyperlink utilisé dans TextFormatElement.
InsertSectionCompilateur pour les objets InsertSection.
InsertWidgetCompilateur pour les objets InsertWidget.
LinkObjet de lien provenant d'une ressource tierce qui est converti en chip intelligent dans l'application hôte.
LinkPreview
ListContainerConteneur pour les éléments de liste, où chaque élément de liste peut contenir plusieurs TextFormatElement.
ListItemÉlément de liste, où chaque élément peut contenir plusieurs TextFormatElement.
ListTypeÉnumération représentant le type de liste.
ModifyCardGénérateur d'objets ModifyCard qui modifie et met à jour l'interface d'une fiche existante en transmettant l'objet ModifyCard à un Action.
NavigationObjet d'assistance qui contrôle la navigation dans les cartes.
Notification
OnClose
OpenAs
OpenLink
RemoveSectionCompilateur pour les objets RemoveSection.
RemoveWidgetCompilateur pour les objets RemoveWidget.
RenderActionAffiche ou met à jour une fiche en effectuant une Action en réponse à une interaction de l'utilisateur.
RenderActionBuilderCompilateur pour les objets RenderAction.
ResourceDataReprésente des données de ressources spécifiques à une application. Les données de ressources contiennent une collection de paires clé/valeur de noms de variables et VariableData.
ResourceFieldUn ResourceField est un élément de base d'un DynamicResourceDefinition. Chaque champ de ressource correspond à une variable de sortie de l'étape actuelle.
ResourceFieldsDefinitionRetrievedActionUn ResourceFieldsDefinitionRetrievedAction est un type de ResourceFieldsDefinitionRetrievedAction utilisé pour récupérer la définition d'une liste de champs de ressources via la fonction dynamicResourceDefinitionProvider spécifiée dans le fichier manifeste.
ResourceRetrievedActionUne ResourceRetrievedAction est utilisée pour récupérer le contenu de la ressource personnalisée si nécessaire, où le champ de ressource personnalisée est défini dans ResourceData.
ResourceTypeType de ressource spécifique à une application. L'identifiant unique du type de ressource doit avoir une WorkflowResourceDefinition correspondante.
ReturnElementErrorActionUne ReturnElementErrorAction indique qu'une erreur s'est produite lors de l'appel d'un élément.
ReturnOutputVariablesActionContient les variables de sortie générées par l'action exécutée dans Google Workspace Studio.
SaveWorkflowActionCette action indique que l'application hôte (Google Workspace Studio) doit enregistrer l'agent.
SendStatus
StyledTextÉlément de texte avec des styles tels que le gras, l'italique et la couleur.
TextFormatChipChip cliquable au format texte.
TextFormatElementÉlément de format de texte, qui peut être TextFormatChip, StyledText, Hyperlink ou ListContainer.
TextFormatIconIcône affichée dans un TextFormatChip.
TextStyleÉnumération représentant le style du texte mis en forme.
TimeStampReprésente un objet d'horodatage qui peut être ajouté à un VariableData.
UniversalActionResponse
UniversalActionResponseBuilder
UpdateDraftActionResponse
UpdateDraftActionResponseBuilder
UpdateDraftBccRecipientsAction
UpdateDraftBodyAction
UpdateDraftBodyType
UpdateDraftCcRecipientsAction
UpdateDraftSubjectAction
UpdateDraftToRecipientsAction
UpdateInlinePreviewAction
UpdateMessageAction
UpdateWidgetCompilateur pour les objets UpdateWidget.
ValidationErrorSeverityÉnumération représentant la gravité de l'erreur de validation.
ValueMetadataUn objet valueMetadata contient des informations sur les valeurs potentielles d'une variable.
VariableDataReprésente une variable de données pouvant contenir une collection de valeurs de différents types.
WorkflowActionWorkflowAction est un type de HostAppAction utilisé pour effectuer une action spécifique dans Google Workspace Studio.
WorkflowTextFormatBloc de texte avec des options de mise en forme enrichie, y compris des styles, des liens hypertextes et des éléments interactifs définis dans TextFormatElement.
WorkflowValidationErrorActionCette action indique que l'application hôte (Google Workspace Studio) doit afficher une erreur de validation.

AccessoryWidget

Méthodes

MéthodeType renvoyéBrève description
addWidget(widget)AccessoryWidgetDéfinit le widget pour cette action.

Action

Méthodes

MéthodeType renvoyéBrève description
addModifyCard(modifyCard)ActionAjoute une opération ModifyCard à l'action.
addNavigation(navigation)ActionAjoute une navigation par carte à l'action.

ActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

ActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
addModifyCard(modifyCard)ActionResponseBuilderDéfinit l'opération de modification de la carte sur l'action.
build()ActionResponseCrée la réponse à l'action en cours et la valide.
setLinkPreview(linkPreview)ActionResponseBuilderDéfinit LinkPreview sur l'action.
setNavigation(navigation)ActionResponseBuilderDéfinit la réponse à une action Navigation.
setNotification(notification)ActionResponseBuilderDéfinit la notification à afficher lorsque l'action est activée.
setOpenLink(openLink)ActionResponseBuilderDéfinit l'URL vers laquelle accéder lorsque l'action est activée.
setStateChanged(stateChanged)ActionResponseBuilderDéfinit un indicateur pour indiquer que cette action a modifié l'état des données existantes.

AddOnsResponseService

Propriétés

PropriétéTypeDescription
AddonComposeUiActionTypeAddonComposeUiActionTypeÉnumération AddonComposeUiActionType.
ComposedEmailTypeComposedEmailTypeÉnumération ComposedEmailType.
ContentTypeContentTypeÉnumération ContentType.
EndNavigationEndNavigationÉnumération EndNavigation.
OnCloseOnCloseÉnumération OnClose.
OpenAsOpenAsÉnumération OpenAs.
SendStatusSendStatusÉnumération SendStatus.
UpdateDraftBodyTypeUpdateDraftBodyTypeÉnumération UpdateDraftBodyType.

Méthodes

MéthodeType renvoyéBrève description
newAccessoryWidget()AccessoryWidgetcrée un objet AccessoryWidget ;
newAction()Actioncrée un objet Action ;
newActionResponseBuilder()ActionResponseBuilderCrée un objet ActionResponseBuilder.
newAddonComposeUiActionResponseBuilder()AddonComposeUiActionResponseBuilderCrée un objet AddonComposeUiActionResponseBuilder.
newAttachment()AttachmentCrée un objet Attachment.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCrée un objet CalendarEventActionResponseBuilder.
newChatDataActionBuilder()ChatDataActionsResponseBuilderCrée un objet ChatDataActionsResponseBuilder.
newChatMessage()ChatMessageCrée un objet ChatMessage.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrée un objet ComposeActionResponseBuilder.
newCreateMessageAction()CreateMessageActionCrée un objet CreateMessageAction.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCrée un objet DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCrée un objet EditorFileScopeActionResponseBuilder.
newLinkPreview()LinkPreviewCrée un objet LinkPreview.
newNavigation()NavigationCrée un objet Navigation.
newNotification()NotificationCrée un objet Notification.
newOpenLink()OpenLinkCrée un objet OpenLink.
newRenderActionBuilder()RenderActionBuildercrée un objet RenderActionBuilder ;
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCrée un objet UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCrée un objet UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCrée un UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionCrée un objet UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCrée un objet UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCrée un objet UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCrée un objet UpdateDraftToRecipientsAction.
newUpdateInlinePreviewAction()UpdateInlinePreviewActionCrée un objet UpdateInlinePreviewAction.
newUpdateMessageAction()UpdateMessageActionCrée un objet UpdateMessageAction.

AddonComposeUiActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

AddonComposeUiActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()AddonComposeUiActionResponseCrée la réponse d'action de l'UI de composition de l'addon actuel et la valide.
setType(type)AddonComposeUiActionResponseBuilderDéfinit le champ d'énumération qui détermine l'action de l'interface utilisateur de composition du module complémentaire.

AddonComposeUiActionType

Propriétés

PropriétéTypeDescription
DISMISSEnumPar défaut.

Attachment

Méthodes

MéthodeType renvoyéBrève description
setIconUrl(iconUrl)AttachmentDéfinit l'URL de l'icône de la pièce jointe.
setMimeType(mimeType)AttachmentDéfinit le type MIME de la pièce jointe.
setResourceUrl(resourceUrl)AttachmentDéfinit l'URL de la ressource pour la pièce jointe.
setTitle(title)AttachmentDéfinit le titre de la pièce jointe.

BasicDataType

Propriétés

PropriétéTypeDescription
BASIC_TYPE_UNSPECIFIEDEnumValeur par défaut.
STRINGEnumChaîne de caractères.
INTEGEREnumValeur entière.
FLOATEnumNombre à virgule flottante.
TIMESTAMPEnumCode temporel au format ISO 8601.
BOOLEANEnumUne valeur booléenne.
EMAIL_ADDRESSEnumChaîne au format d'une adresse e-mail.
GOOGLE_USEREnumUtilisateur des services Google, au format "users/encoded_GAIA_ID"
FILEEnumType de fichier.
FORMATTED_TEXTEnumTexte avec une mise en forme enrichie.

CalendarEventActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

CalendarEventActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
addAttachments(attachments)CalendarEventActionResponseBuilderIndique que la réponse doit ajouter les pièces jointes à l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.
addAttendees(emails)CalendarEventActionResponseBuilderIndique que la réponse doit ajouter les participants indiqués à l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.
build()CalendarEventActionResponseCrée la réponse de l'action d'événement d'agenda actuelle et la valide.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderIndique que la réponse doit définir les données de conférence indiquées sur l'événement d'agenda lorsque l'action d'interface utilisateur associée est effectuée.

ChatDataActionsResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()DataActionsResponseCrée la réponse de l'action en cours.
setCreateChatMessageAction(createMessageAction)ChatDataActionsResponseBuilderDéfinit le CreateMessageAction pour ce DataActionsResponse.
setUpdateChatMessageAction(updateMessageAction)ChatDataActionsResponseBuilderDéfinit le UpdateMessageAction pour ce DataActionsResponse.
setUpdateInlinePreviewAction(updateInlinePreviewAction)ChatDataActionsResponseBuilderDéfinit le UpdateInlinePreviewAction pour ce DataActionsResponse.

ChatMessage

Méthodes

MéthodeType renvoyéBrève description
addCardWithId(cardWithId)ChatMessageDéfinit la carte du message.
setText(text)ChatMessageDéfinit le texte du message.

Color

Méthodes

MéthodeType renvoyéBrève description
setAlpha(alpha)ColorDéfinit le composant alpha de la couleur.
setBlue(blue)ColorDéfinit le composant bleu de la couleur.
setGreen(green)ColorDéfinit le composant vert de la couleur.
setRed(red)ColorDéfinit le composant rouge de la couleur.

ComposeActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

ComposeActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()ComposeActionResponseCrée la réponse de l'action de composition actuelle et la valide.
setGmailDraft(draft)ComposeActionResponseBuilderDéfinit le brouillon GmailMessage créé à l'aide de GmailMessage.createDraftReply(body) ou de fonctions similaires.

ComposedEmailType

Propriétés

PropriétéTypeDescription
REPLY_AS_DRAFTEnumBrouillon qui est une réponse à un autre message.
STANDALONE_DRAFTEnumBrouillon qui est un message autonome.

ContentType

Propriétés

PropriétéTypeDescription
TEXTEnumIndique que le contenu généré est en texte brut.
MUTABLE_HTMLEnumIndique que le contenu généré est au format HTML.
IMMUTABLE_HTMLEnumIndique que le contenu généré est au format HTML, mais qu'il ne peut pas être modifié après sa génération.

CreateMessageAction

Méthodes

MéthodeType renvoyéBrève description
setMessage(message)CreateMessageActionDéfinit le message pour cette action.

DataActionsResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

DataType

Méthodes

MéthodeType renvoyéBrève description
setBasicDataType(basicDataType)DataTypeDéfinit le type de données sur l'un des BasicDataType compatibles.
setResourceType(resourceType)DataTypeDéfinit le type de données sur un ResourceType personnalisé.
setValueMetadata(valueMetadata)DataTypeDéfinit le ValueMetadata, qui contient des informations liées au type de la variable.

DriveItemsSelectedActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

DriveItemsSelectedActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()DriveItemsSelectedActionResponseCrée la réponse de l'action Drive actuelle.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderSpécifie que la réponse demande l'accès au fichier pour l'élément contextuel pertinent dans Drive.

DynamicResourceDefinition

Méthodes

MéthodeType renvoyéBrève description
addResourceField(resourceField)DynamicResourceDefinitionAjoute un champ de ressource à la définition de ressource dynamique.
setResourceId(resourceId)DynamicResourceDefinitionDéfinit l'ID de la définition de ressource dynamique. Cet ID correspond à workflowResourceDefinitionId dans le fichier manifeste.

EditorFileScopeActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

EditorFileScopeActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()EditorFileScopeActionResponseCrée la réponse de l'action de l'éditeur actuel.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderDemande le champ d'application drive.file pour le document Editor actif actuel.

EndNavigation

Propriétés

PropriétéTypeDescription
ACTION_UNSPECIFIEDEnumAction non spécifiée.
CLOSE_DIALOGEnumFerme une boîte de dialogue.
CLOSE_DIALOG_AND_EXECUTEEnumFerme une boîte de dialogue et actualise la fiche qui l'a ouverte.

ErrorActionability

Propriétés

PropriétéTypeDescription
ERROR_ACTIONABILITY_UNSPECIFIEDEnumNon spécifié.
NOT_ACTIONABLEEnumL'utilisateur ne peut pas résoudre l'erreur à l'aide de la fiche de configuration.
ACTIONABLEEnumL'utilisateur peut corriger l'erreur à l'aide de la fiche de configuration.

ErrorRetryability

Propriétés

PropriétéTypeDescription
RETRYABILITY_UNSPECIFIEDEnumNon spécifié.
NOT_RETRYABLEEnumL'erreur ne peut pas être corrigée. Le flux se termine après la première tentative.
RETRYABLEEnumL'erreur est récupérable. Le workflow va essayer d'exécuter l'étape jusqu'à cinq fois.

FontWeight

Propriétés

PropriétéTypeDescription
FONT_WEIGHT_UNSPECIFIEDEnumPoids standard avec une épaisseur normale.
LIGHTEnumPlus léger et moins épais.
MEDIUMEnumPoids intermédiaire entre le style clair et le style gras.
BOLDEnumPoids plus élevé avec une épaisseur accrue.

HostAppAction

Méthodes

MéthodeType renvoyéBrève description
setWorkflowAction(workflowAction)HostAppActionDéfinit l'action de l'application hôte sur l'action de workflow.

Méthodes

MéthodeType renvoyéBrève description
setLink(link)HyperlinkDéfinit l'URL de destination du lien hypertexte.
setText(text)HyperlinkDéfinit le texte du lien hypertexte.

InsertSection

Méthodes

MéthodeType renvoyéBrève description
insertAtTop(onCardTop)InsertSectionDéfinit l'indicateur onCardTop, qui indique si la nouvelle section doit être insérée en haut de la carte.
insertBelowSection(sectionId)InsertSectionDéfinit l'ID de la section. La nouvelle section est insérée en dessous.
setSection(section)InsertSectionDéfinit la section de carte à insérer.

InsertWidget

Méthodes

MéthodeType renvoyéBrève description
insertAboveWidget(widgetId)InsertWidgetDéfinit l'ID du widget. Le nouveau widget est inséré au-dessus du widget portant l'ID spécifié.
insertBelowWidget(widgetId)InsertWidgetDéfinit l'ID du widget. Le nouveau widget est inséré sous le widget portant l'ID spécifié.
setWidget(widget)InsertWidgetDéfinit le Widget à insérer.

Méthodes

MéthodeType renvoyéBrève description
setTitle(title)LinkDéfinit le titre du lien.
setUrl(url)LinkDéfinit l'URL du lien.

LinkPreview

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.
setLinkPreviewTitle(title)LinkPreviewDéfinit le titre qui s'affiche dans l'aperçu du lien au-dessus de la fiche d'aperçu.
setPreviewCard(previewCard)LinkPreviewDéfinit la fiche qui affiche des informations sur un lien provenant d'un service tiers ou non Google.
setTitle(title)LinkPreviewDéfinit le titre qui s'affiche dans le chip intelligent pour l'aperçu du lien.

ListContainer

Méthodes

MéthodeType renvoyéBrève description
addListItem(listItem)ListContainerAjoute un élément de liste au conteneur de liste.
setListNestLevel(listLevel)ListContainerDéfinit le niveau de la liste. La valeur est de 0 pour le niveau supérieur et augmente de 1 pour chaque liste imbriquée.
setListType(listType)ListContainerDéfinit le type de liste (ordonnée ou non ordonnée).

ListItem

Méthodes

MéthodeType renvoyéBrève description
addTextFormatElement(textFormatElement)ListItemAjoute un TextFormatElement à l'élément de liste.

ListType

Propriétés

PropriétéTypeDescription
LIST_TYPE_UNSPECIFIEDEnumValeur par défaut.
ORDEREDEnumListe ordonnée.
UNORDEREDEnumListe non triée.

ModifyCard

Méthodes

MéthodeType renvoyéBrève description
setInsertSection(insertSection)ModifyCardDéfinit le InsertSection pour cet objet de fiche de modification.
setInsertWidget(insertWidget)ModifyCardDéfinit le InsertWidget pour cet objet de fiche de modification.
setRemoveSection(removeSection)ModifyCardDéfinit le RemoveSection pour cet objet de fiche de modification.
setRemoveWidget(removeWidget)ModifyCardDéfinit le RemoveWidget pour cet objet de fiche de modification.
setReplaceSection(replacementSection)ModifyCardDéfinit le CardSection de remplacement pour cet objet de modification de carte. La section de remplacement doit avoir le même ID qu'une section de carte existante.
setReplaceWidget(replacementWidget)ModifyCardDéfinit le widget de remplacement pour cet objet de carte de modification. Le widget de remplacement doit avoir le même ID qu'un widget existant.
setUpdateWidget(updateWidget)ModifyCardDéfinit le UpdateWidget pour cet objet de fiche de modification.

Méthodes

MéthodeType renvoyéBrève description
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()StringAffiche la représentation JSON de cet objet.
pushCard(card)NavigationTransfère la carte donnée sur la pile.
setEndNavigation(endNavigation)NavigationDéfinit l'action de navigation de fin.
updateCard(card)NavigationRemplace la carte actuelle.

Notification

Méthodes

MéthodeType renvoyéBrève description
setText(text)NotificationDéfinit le texte à afficher dans la notification.

OnClose

Propriétés

PropriétéTypeDescription
NOTHINGEnumNe rien faire à la fermeture.
RELOADEnumRecharge le module complémentaire lorsque la fenêtre se ferme.

OpenAs

Propriétés

PropriétéTypeDescription
FULL_SIZEEnumOuvrez-le en plein écran ou dans un onglet.
OVERLAYEnumOuvrez-le sous forme de superposition, comme un pop-up.

Méthodes

MéthodeType renvoyéBrève description
setOnClose(onClose)OpenLinkDéfinit le comportement de l'action d'URL lorsque la fenêtre ou l'onglet de l'URL sont fermés.
setOpenAs(openAs)OpenLinkDéfinit le comportement de l'URL lorsqu'elle est ouverte.
setUrl(url)OpenLinkDéfinit l'URL à ouvrir.

RemoveSection

Méthodes

MéthodeType renvoyéBrève description
setSectionId(sectionId)RemoveSectionDéfinit l'ID de la section à supprimer.

RemoveWidget

Méthodes

MéthodeType renvoyéBrève description
setWidgetId(widgetId)RemoveWidgetDéfinit l'ID du widget à supprimer.

RenderAction

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

RenderActionBuilder

Méthodes

MéthodeType renvoyéBrève description
build()RenderActionCrée l'action de rendu actuelle et la valide.
setAction(action)RenderActionBuilderDéfinit l'action que les modules complémentaires peuvent utiliser pour mettre à jour l'UI sur l'action de rendu.
setHostAppAction(hostAppAction)RenderActionBuilderDéfinit les HostAppAction gérés par les applications hôtes individuelles sur l'action de rendu.

ResourceData

Méthodes

MéthodeType renvoyéBrève description
addVariableData(key, value)ResourceDataAjoute un VariableData identifié par son nom de variable. Si la clé existe déjà, la valeur est remplacée.
setVariableDataMap(fields)ResourceDataDéfinit la carte des données de variables associées aux noms de variables.

ResourceField

Méthodes

MéthodeType renvoyéBrève description
setDataType(dataType)ResourceFieldDéfinit le type de données du champ et permet aux autres étapes de filtrer les variables par type lors de la sélection.
setDisplayText(displayText)ResourceFieldDéfinit la description du champ qui s'affiche pour l'utilisateur final lors de la sélection des variables dans les étapes suivantes.
setSelector(selector)ResourceFieldDéfinit une clé pour que la fonction de fournisseur fournisse la valeur lors de l'exécution de l'étape.

ResourceFieldsDefinitionRetrievedAction

Méthodes

MéthodeType renvoyéBrève description
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionAjoute un DynamicResourceDefinition à l'action de récupération de la définition des champs de ressources.

ResourceRetrievedAction

Méthodes

MéthodeType renvoyéBrève description
setResourceData(resourceData)ResourceRetrievedActionDéfinit ResourceData sur l'action de récupération de la ressource pour fournir des valeurs aux champs de ressources dynamiques ou aux champs de ressources personnalisés.

ResourceType

Méthodes

MéthodeType renvoyéBrève description
setWorkflowResourceDefinitionId(resourceType)ResourceTypeDéfinit l'ID de définition de ressource du workflow.

ReturnElementErrorAction

Méthodes

MéthodeType renvoyéBrève description
setErrorActionability(errorActionability)ReturnElementErrorActionDéfinit l'actionnabilité de l'erreur. Une erreur doit être actionable si elle peut être résolue en reconfigurant l'étape.
setErrorLog(log)ReturnElementErrorActionDéfinit le journal des erreurs à afficher à l'utilisateur final dans le flux d'activité du workflow.
setErrorRetryability(errorRetryability)ReturnElementErrorActionDéfinit la possibilité de nouvelle tentative en cas d'erreur. Le flux se termine après la première tentative si une erreur ne peut pas faire l'objet d'une nouvelle tentative.

ReturnOutputVariablesAction

Méthodes

MéthodeType renvoyéBrève description
addVariableData(key, value)ReturnOutputVariablesActionAjoute une variable de données indexée par son nom de variable. Une valeur est écrasée si la clé existe déjà.
setLog(log)ReturnOutputVariablesActionDéfinit le journal de l'action de workflow exécutée pour l'utilisateur final dans le flux d'activité du workflow.
setVariableDataMap(variables)ReturnOutputVariablesActionDéfinit la carte des données de variables indexées par nom de variable. Une valeur est écrasée si la clé existe déjà.

SaveWorkflowAction

SendStatus

Propriétés

PropriétéTypeDescription
NOT_SENDEnumPar défaut.
CONTINUE_SENDEnumContinuer à envoyer l'e-mail après avoir modifié le brouillon

StyledText

Méthodes

MéthodeType renvoyéBrève description
addStyle(style)StyledTextDéfinit le style du texte stylisé. Plusieurs styles peuvent être appliqués à un même texte stylisé.
setColor(color)StyledTextDéfinit la couleur du texte stylisé.
setFontWeight(fontWeight)StyledTextDéfinit l'épaisseur de la police du texte stylisé.
setText(text)StyledTextDéfinit le contenu principal du texte stylisé.

TextFormatChip

Méthodes

MéthodeType renvoyéBrève description
setLabel(label)TextFormatChipDéfinit le texte affiché dans le chip.
setTextFormatIcon(icon)TextFormatChipDéfinit l'icône affichée dans le chip.
setUrl(url)TextFormatChipDéfinit l'URL vers laquelle rediriger l'utilisateur lorsqu'il clique sur le chip.

TextFormatElement

Méthodes

MéthodeType renvoyéBrève description
setHyperlink(hyperlink)TextFormatElementDéfinit l'élément de format de texte comme Hyperlink.
setListContainer(listContainer)TextFormatElementDéfinit l'élément de format de texte comme ListContainer.
setStyledText(styledText)TextFormatElementDéfinit l'élément de format de texte comme StyledText.
setText(text)TextFormatElementDéfinit l'élément de format de texte en tant que chaîne de texte.
setTextFormatChip(chip)TextFormatElementDéfinit l'élément de format de texte comme TextFormatChip.

TextFormatIcon

Méthodes

MéthodeType renvoyéBrève description
setIconUrl(iconUrl)TextFormatIconDéfinit l'URL de l'icône.
setMaterialIconName(materialIconName)TextFormatIconDéfinit le nom de l'icône Material défini dans Google Material Icons.

TextStyle

Propriétés

PropriétéTypeDescription
STYLE_UNSPECIFIEDEnumAucun style appliqué.
ITALICEnumStyle italique.
UNDERLINEEnumStyle de soulignement.
STRIKETHROUGHEnumStyle barré.
LINE_BREAKEnumSaut de ligne.
UPPERCASEEnumStyle en majuscules.
CODEEnumStyle de code.
CODE_BLOCKEnumStyle du bloc de code.

TimeStamp

Méthodes

MéthodeType renvoyéBrève description
setNanos(nanos)TimeStampDéfinit les nanosecondes du code temporel. Il s'agit du nombre de nanosecondes dans la seconde actuelle.
setSeconds(seconds)TimeStampDéfinit les secondes du code temporel. Il s'agit du nombre de secondes écoulées depuis l'epoch Unix(1er janvier 1970, 00:00:00 UTC).

UniversalActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

UniversalActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()UniversalActionResponseCrée la réponse d'action universelle actuelle et la valide.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderAffiche le module complémentaire avec les fiches spécifiées.
setOpenLink(openLink)UniversalActionResponseBuilderDéfinit l'URL à ouvrir lorsque l'action universelle est sélectionnée.

UpdateDraftActionResponse

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.

UpdateDraftActionResponseBuilder

Méthodes

MéthodeType renvoyéBrève description
build()UpdateDraftActionResponseCrée la réponse à l'action de mise à jour actuelle et la valide.
setSendStatus(sendStatus)UpdateDraftActionResponseBuilderDéfinit le champ d'énumération qui détermine si l'e-mail est envoyé après l'action de mise à jour.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires en copie cachée d'un brouillon d'e-mail.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDéfinissez une action qui met à jour le corps d'un brouillon d'e-mail.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires en copie conforme d'un brouillon.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour la ligne d'objet d'un brouillon.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderDéfinit une action qui met à jour les destinataires "À" d'un brouillon.

UpdateDraftBccRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionMet à jour les destinataires en copie cachée d'un brouillon d'e-mail.

UpdateDraftBodyAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateContent(content, contentType)UpdateDraftBodyActionAjoute le contenu spécifié au corps du brouillon.
setUpdateType(updateType)UpdateDraftBodyActionDéfinit le UpdateDraftBodyType de cette action de mise à jour sur le corps du brouillon.

UpdateDraftBodyType

Propriétés

PropriétéTypeDescription
IN_PLACE_INSERTEnumPar défaut.
INSERT_AT_STARTEnumLes actions de mise à jour insèrent du contenu au début du corps du message.
INSERT_AT_ENDEnumLes actions de mise à jour insèrent du contenu à la fin du corps du message.

UpdateDraftCcRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionMet à jour les destinataires en copie d'un brouillon d'e-mail.

UpdateDraftSubjectAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateSubject(subject)UpdateDraftSubjectActionCette action met à jour la ligne d'objet d'un brouillon d'e-mail.

UpdateDraftToRecipientsAction

Méthodes

MéthodeType renvoyéBrève description
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionCette action met à jour les destinataires "À" d'un brouillon d'e-mail.

UpdateInlinePreviewAction

Méthodes

MéthodeType renvoyéBrève description
addCardWithId(cardWithId)UpdateInlinePreviewActionAjoute la fiche pour cette action.
addExpiration(ttl)UpdateInlinePreviewActionAjoute la date d'expiration pour cette action.

UpdateMessageAction

Méthodes

MéthodeType renvoyéBrève description
setMessage(message)UpdateMessageActionDéfinit le message pour cette action.

UpdateWidget

Méthodes

MéthodeType renvoyéBrève description
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetAjoute un nouvel élément pouvant être sélectionné pour les menus à sélection multiple.

ValidationErrorSeverity

Propriétés

PropriétéTypeDescription
SEVERITY_UNSPECIFIEDEnumNon spécifié.
CRITICALEnumCritique : l'erreur est critique et doit être corrigée avant la publication.
WARNINGEnumAvertissement : l'erreur n'est pas critique et n'empêche pas la publication.

ValueMetadata

Méthodes

MéthodeType renvoyéBrève description
addCastableType(dataType)ValueMetadataAjoute des types autorisés facultatifs qui peuvent être convertis dynamiquement pour les données d'une variable à ces métadonnées de valeur.
addEnumValue(enumValue)ValueMetadataAjoute une valeur de chaîne facultative aux valeurs d'énumération autorisées d'une variable. Ce champ ne peut être défini que si DataType est défini sur le type "String".
setDefaultValue(defaultValue)ValueMetadataDéfinit la valeur par défaut facultative de la variable. Par exemple, si le type de variable est booléen, defaultValue peut être défini sur "true" ou "false".

VariableData

Méthodes

MéthodeType renvoyéBrève description
addBooleanValue(value)VariableDataAjoute une valeur booléenne aux données de la variable.
addEmailAddress(emailAddress)VariableDataAjoute une adresse e-mail aux données de variable.
addFloatValue(value)VariableDataAjoute une valeur float aux données de la variable.
addGoogleUser(googleUser)VariableDataAjoute un utilisateur Google aux données de la variable.
addIntegerValue(value)VariableDataAjoute une valeur entière aux données de la variable.
addResourceData(resourceData)VariableDataAjoute une valeur ResourceData aux données de la variable.
addResourceReference(resourceReference)VariableDataAjoute un ID de référence de ressource aux données de la variable.
addStringValue(value)VariableDataAjoute une valeur de chaîne aux données de la variable.
addTimestampValue(value)VariableDataAjoute une valeur TimeStamp aux données de la variable.
addWorkflowTextFormat(workflowTextFormat)VariableDataAjoute une valeur WorkflowTextFormat aux données de la variable.

WorkflowAction

WorkflowTextFormat

Méthodes

MéthodeType renvoyéBrève description
addTextFormatElement(textFormatElement)WorkflowTextFormatAjoute un TextFormatElement au format texte du workflow.

WorkflowValidationErrorAction

Méthodes

MéthodeType renvoyéBrève description
setSeverity(severity)WorkflowValidationErrorActionDéfinit la gravité de l'erreur de validation.