Class ActionResponseBuilder

ActionResponseBuilder

Version Preview pour les développeurs : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder de manière anticipée à certaines fonctionnalités.

Compilateur pour les objets ActionResponse.

Disponible pour les modules complémentaires Google Workspace.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .setNotification(notification)
    .build();

Méthodes

Méthode	Type renvoyé	Brève description
addModifyCard(modifyCard)	ActionResponseBuilder	Définit l'opération de modification de la carte sur l'action.
build()	ActionResponse	Crée la réponse à l'action en cours et la valide.
setLinkPreview(linkPreview)	ActionResponseBuilder	Définit LinkPreview sur l'action.
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.

Documentation détaillée

addModifyCard(modifyCard)

Définit l'opération de modification de la carte sur l'action.

Paramètres

Nom	Type	Description
modifyCard	ModifyCard	Le ModifyCard à utiliser.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.

---

build()

Crée la réponse à l'action en cours et la valide.

Renvois

ActionResponse : une ActionResponse validée.

Génère

Error : si la réponse d'action construite n'est pas valide.

---

setLinkPreview(linkPreview)

Définit LinkPreview sur l'action.

Paramètres

Nom	Type	Description
linkPreview	LinkPreview	Le LinkPreview à utiliser.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.

---

setNavigation(navigation)

Définit la réponse à une action Navigation.

const navigation = AddOnsResponseService.newNavigation()
    .setEndNavigation(AddOnsResponseService.EndNavigation.CLOSE_DIALOG);

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNavigation(navigation)
    .build();

Paramètres

Nom	Type	Description
navigation	Navigation	Le Navigation à utiliser.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.

---

setNotification(notification)

Définit la notification à afficher lorsque l'action est activée.

const notification = AddOnsResponseService.newNotification().setText("You closed a dialog!");

const action = AddOnsResponseService.newActionResponseBuilder()
    .setNotification(notification)
    .build();

Paramètres

Nom	Type	Description
notification	Notification	Le Notification à utiliser.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.

---

setOpenLink(openLink)

Définit l'URL vers laquelle accéder lorsque l'action est activée.

Paramètres

Nom	Type	Description
openLink	OpenLink	Le OpenLink à utiliser.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.

---

setStateChanged(stateChanged)

Définit un indicateur pour indiquer que cette action a modifié l'état des données existantes. Par exemple, si l'action a créé une tâche ou mis à jour des coordonnées. Lorsque ce signal est défini sur true, les services tels que Gmail peuvent tenter d'effacer toutes les données d'état mises en cache associées à cette action.

Paramètres

Nom	Type	Description
stateChanged	Boolean	Indique si cette action a modifié les données d'état existantes. La valeur par défaut est false.

Renvois

ActionResponseBuilder : cet objet, pour le chaînage.