Les objets Action vous permettent de créer un comportement interactif dans les modules complémentaires Google Workspace. Ils définissent ce qui se passe lorsqu'un utilisateur interagit avec un widget (par exemple, un bouton) dans l'interface utilisateur du module complémentaire.
Une action est associée à un widget donné à l'aide d'une fonction de gestionnaire de widget, qui définit également la condition qui déclenche l'action. Lorsqu'elle est déclenchée, l'action exécute une fonction de rappel désignée. La fonction de rappel reçoit un objet d'événement qui contient des informations sur les interactions côté client de l'utilisateur. Vous devez implémenter la fonction de rappel et lui demander de renvoyer un objet de réponse spécifique.
Par exemple, imaginons que vous souhaitiez qu'un bouton crée et affiche une nouvelle fiche lorsqu'il est cliqué. Pour ce faire, vous devez créer un widget de bouton et utiliser la fonction de gestionnaire de widget de bouton setOnClickAction(action) pour définir un Action de création de cartes. La Action que vous définissez spécifie une fonction de rappel Apps Script qui s'exécute lorsque l'utilisateur clique sur le bouton. Dans ce cas, vous implémentez la fonction de rappel pour créer la fiche souhaitée et renvoyer un objet ActionResponse. L'objet de réponse indique au module complémentaire d'afficher la fiche créée par la fonction de rappel.
Cette page décrit les actions de widget spécifiques à Agenda que vous pouvez inclure dans votre module complémentaire.
Interactions dans l'agenda
Les modules complémentaires Google Workspace qui étendent Agenda peuvent inclure quelques actions de widget supplémentaires spécifiques à Agenda. Ces actions nécessitent que la fonction de rappel de l'action associée renvoie des objets de réponse spécialisés :
| Action tentée | La fonction de rappel doit renvoyer |
|---|---|
| Ajouter des participants | CalendarEventActionResponse |
| Définir les données de la conférence | CalendarEventActionResponse |
| Ajouter des pièces jointes | CalendarEventActionResponse |
Pour utiliser ces actions de widget et ces objets de réponse, toutes les conditions suivantes doivent être remplies :
- L'action est déclenchée lorsque l'utilisateur a un événement d'agenda ouvert.
- Le champ manifeste
addOns.calendar.currentEventAccessdu module complémentaire est défini surWRITEouREAD_WRITE. - Le module complémentaire inclut le champ d'application Agenda
https://www.googleapis.com/auth/calendar.addons.current.event.write.
En outre, les modifications apportées par la fonction de rappel d'action ne sont pas enregistrées tant que l'utilisateur n'a pas enregistré l'événement d'agenda.
Ajouter des participants à l'aide d'une fonction de rappel
L'exemple suivant montre comment créer un bouton qui ajoute un participant spécifique à un événement de calendrier en cours de modification :
/**
* Build a simple card with a button that sends a notification.
* This function is called as part of the eventOpenTrigger that builds
* a UI when the user opens an event.
*
* @param e The event object passed to eventOpenTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onAddAttendeesButtonClicked');
var button = CardService.newTextButton()
.setText('Add new attendee')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can add
// attendees and disable the button if not.
if (!e.calendar.capabilities.canAddAttendees) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Adds attendees to the
* Calendar event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onAddAttendeesButtonClicked (e) {
return CardService.newCalendarEventActionResponseBuilder()
.addAttendees(["aiko@example.com", "malcom@example.com"])
.build();
}
Définir des données de conférence avec une fonction de rappel
Cette action définit les données de la conférence sur l'événement ouvert. Pour ces données de conférence, l'ID de la solution de conférence doit être spécifié, car l'action n'a pas été déclenchée par la sélection de la solution souhaitée par l'utilisateur.
L'exemple suivant montre comment créer un bouton qui définit les données de conférence pour un événement en cours de modification :
/**
* Build a simple card with a button that sends a notification.
* This function is called as part of the eventOpenTrigger that builds
* a UI when the user opens a Calendar event.
*
* @param e The event object passed to eventOpenTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onSaveConferenceOptionsButtonClicked')
.setParameters(
{'phone': "1555123467", 'adminEmail': "joyce@example.com"});
var button = CardService.newTextButton()
.setText('Add new attendee')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can set
// conference data and disable the button if not.
if (!e.calendar.capabilities.canSetConferenceData) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Sets conference data for the
* Calendar event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onSaveConferenceOptionsButtonClicked(e) {
var parameters = e.commonEventObject.parameters;
// Create an entry point and a conference parameter.
var phoneEntryPoint = ConferenceDataService.newEntryPoint()
.setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
.setUri('tel:' + parameters['phone']);
var adminEmailParameter = ConferenceDataService.newConferenceParameter()
.setKey('adminEmail')
.setValue(parameters['adminEmail']);
// Create a conference data object to set to this Calendar event.
var conferenceData = ConferenceDataService.newConferenceDataBuilder()
.addEntryPoint(phoneEntryPoint)
.addConferenceParameter(adminEmailParameter)
.setConferenceSolutionId('myWebScheduledMeeting')
.build();
return CardService.newCalendarEventActionResponseBuilder()
.setConferenceData(conferenceData)
.build();
}
Ajouter des pièces jointes avec une fonction de rappel
L'exemple suivant montre comment créer un bouton qui ajoute une pièce jointe à un événement Agenda en cours de modification:
/**
* Build a simple card with a button that creates a new attachment.
* This function is called as part of the eventAttachmentTrigger that
* builds a UI when the user goes through the add-attachments flow.
*
* @param e The event object passed to eventAttachmentTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onAddAttachmentButtonClicked');
var button = CardService.newTextButton()
.setText('Add a custom attachment')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can add
// attachments and disable the button if not.
if (!e.calendar.capabilities.canAddAttachments) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Adds attachments to the Calendar
* event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onAddAttachmentButtonClicked(e) {
return CardService.newCalendarEventActionResponseBuilder()
.addAttachments([
CardService.newAttachment()
.setResourceUrl("https://example.com/test")
.setTitle("Custom attachment")
.setMimeType("text/html")
.setIconUrl("https://example.com/test.png")
])
.build();
}
Définir l'icône de pièce jointe
L'icône de pièce jointe doit être hébergée sur l'infrastructure de Google. Pour en savoir plus, consultez la section Fournir des icônes d'attachement.