Acciones del calendario

Los objetos Action te permiten crear un comportamiento interactivo en los complementos de Google Workspace. Definen lo que sucede cuando un usuario interactúa con un widget (por ejemplo, un botón) en la IU del complemento.

Una acción se adjunta a un widget determinado con una función de controlador de widgets, que también define la condición que activa la acción. Cuando se activa, la acción ejecuta una función de devolución de llamada designada. A la función de devolución de llamada se le pasa un objeto de evento que contiene información sobre las interacciones del usuario del cliente. Debes implementar la función de devolución de llamada y hacer que muestre un objeto de respuesta específico.

Por ejemplo, supongamos que quieres que un botón cree y muestre una tarjeta nueva cuando se hace clic en él. Para ello, debes crear un nuevo widget de botón y usar la función de controlador de widget de botón setOnClickAction(action) para configurar un Action de creación de tarjetas. El Action que defines especifica una función de devolución de llamada de Apps Script que se ejecuta cuando se hace clic en el botón. En este caso, debes implementar la función de devolución de llamada para compilar la tarjeta que deseas y mostrar un objeto ActionResponse. El objeto de respuesta le indica al complemento que muestre la tarjeta que creó la función de devolución de llamada.

En esta página, se describen las acciones de widgets específicas del Calendario que puedes incluir en tu complemento.

Interacciones con el Calendario

Los complementos de Google Workspace que extienden el Calendario pueden incluir algunas acciones adicionales de widgets específicos del Calendario. Estas acciones requieren la acción asociada de función de devolución de llamada para mostrar objetos de respuesta especializados:

Intento de acción La función de devolución de llamada debería mostrar
Cómo agregar asistentes CalendarEventActionResponse
Configuración de los datos de la conferencia CalendarEventActionResponse
Cómo agregar archivos adjuntos CalendarEventActionResponse

Para usar estas acciones de widgets y objetos de respuesta, se deben cumplir todas las siguientes condiciones:

  • La acción se activa mientras el usuario tiene un evento de Calendario abierto.
  • El campo de manifiesto addOns.calendar.currentEventAccess del complemento está configurado como WRITE o READ_WRITE.
  • El complemento incluye el https://www.googleapis.com/auth/calendar.addons.current.event.write alcance de Calendario.

Además, los cambios que realice la función de devolución de llamada de acción no se guardarán hasta que el usuario guarde el evento de Calendario.

Agrega asistentes con una función de devolución de llamada

En el siguiente ejemplo, se muestra cómo crear un botón que agregue un invitado específico a un evento de Calendario que se está editando:

  /**
   * 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();
  }

Cómo configurar datos de conferencia con una función de devolución de llamada

Esta acción establece los datos de la conferencia en el evento abierto. Para estos datos de conferencia, se debe especificar el ID de la solución de conferencia, ya que el usuario no activó la acción seleccionando la solución deseada.

En el siguiente ejemplo, se muestra cómo crear un botón que establezca los datos de la conferencia para un evento que se está editando:

  /**
   * 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();
  }

Agrega archivos adjuntos con una función de devolución de llamada

En el siguiente ejemplo, se muestra cómo crear un botón que agregue un archivo adjunto a un evento de Calendario que se está editando:

  /**
   * 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();
  }

Cómo configurar el ícono de archivo adjunto

El ícono del archivo adjunto debe estar alojado en la infraestructura de Google. Consulta Cómo proporcionar íconos de archivos adjuntos para obtener más detalles.