Acciones del calendario

Los objetos Action te permiten compilar imágenes comportamiento 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 a través de un Función de controlador del widget, que también define la condición que activa la acción. Cuando se activa, ejecuta una acción designada función de devolución de llamada. La función de devolución de llamada recibe un objeto de evento que lleve información sobre las interacciones del usuario con el cliente. Debes implementar el función de devolución de llamada y que devuelva 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 secuencia de comandos de Apps Script. función de devolución de llamada 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 con la devolución de llamada función compilada.

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

Interacciones con el Calendario

Complementos de Google Workspace que extienden Calendario Puedes incluir algunas acciones adicionales de widgets específicos del Calendario. Estas acciones Requerir la acción asociada de función de devolución de llamada. para mostrar objetos de respuesta especializados:

Acción realizada La función de devolución de llamada debe 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 del widget y los objetos de respuesta, todo lo siguiente debe ser verdadero:

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

Además, los cambios realizados por la función de devolución de llamada de acción no se guardan hasta el usuario guarda el evento de calendario.

Cómo agregar 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();
  }

Configuración de datos de conferencias con una función de devolución de llamada

Esta acción establece los datos de la conferencia en el evento abierto. Datos de esta conferencia se debe especificar el ID de la solución de conferencia, ya que la acción no se que el usuario seleccione la solución deseada.

En el siguiente ejemplo, se muestra cómo crear un botón que establezca datos de la conferencia en el caso de 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 en edición:

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

Configuración del í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.