Ações da agenda

Os objetos Action permitem criar um comportamento interativo nos complementos do Google Workspace. Eles definem o que acontece quando um usuário interage com um widget (por exemplo, um botão) na IU de complementos.

Uma ação é anexada a um determinado widget usando uma função de gerenciador de widget, que também define a condição que aciona a ação. Quando acionada, a ação executa uma função de callback designada. A função de callback recebe um objeto de evento que transporta informações sobre as interações do lado do cliente do usuário. Implemente a função de callback e faça com que ela retorne um objeto de resposta específico.

Por exemplo, digamos que você queira um botão que gere e exiba um novo cartão quando clicado. Para isso, crie um novo widget de botão e use a função setOnClickAction(action) do gerenciador de botões para definir um Action de criação de cards. A Action definida especifica uma função de callback do Apps Script que é executada quando o botão é clicado. Nesse caso, implemente a função de callback para criar o cartão desejado e retorne um objeto ActionResponse. O objeto de resposta instrui o complemento a exibir o card que foi criado pela função de callback.

Esta página descreve as ações de widget específicas do Google Agenda que você pode incluir no seu complemento.

Interações da agenda

Os complementos do Google Workspace que estendem o Agenda podem incluir algumas outras ações de widget específicas do Agenda. Essas ações exigem a função de callback associada para retornar objetos de resposta especializados:

Ação realizada	A função de callback vai retornar
Adicionar participantes	CalendarEventActionResponse
Definir dados de videoconferências	CalendarEventActionResponse
Adicionar anexos	CalendarEventActionResponse

Para usar essas ações de widget e objetos de resposta, todas as condições a seguir precisam ser atendidas:

• A ação é acionada enquanto o usuário tem um evento do Google Agenda aberto.
• O campo do manifesto addOns.calendar.currentEventAccess do complemento está definido como WRITE ou READ_WRITE.
• O complemento inclui o https://www.googleapis.com/auth/calendar.addons.current.event.write escopo da agenda.

Além disso, as mudanças feitas pela função de callback de ação não são salvas até que o usuário salve o evento da agenda.

Como adicionar participantes com uma função de callback

O exemplo a seguir mostra como criar um botão que adiciona um convidado específico a um evento do Agenda que está sendo editado:

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

Definir dados de videoconferência com uma função de callback

Esta ação define os dados de videoconferência do evento aberto. Para esses dados de videoconferência, o ID da solução de videoconferência precisa ser especificado, porque a ação não foi acionada pelo usuário selecionando a solução desejada.

O exemplo a seguir mostra como criar um botão que define os dados de videoconferência de um evento editado:

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

Adicionar anexos com uma função de callback

O exemplo a seguir mostra como criar um botão que adiciona um anexo a um evento do Google Agenda que está sendo editado:

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

Como definir o ícone de anexo

O ícone de anexo precisa ser hospedado na infraestrutura do Google. Consulte Fornecer ícones de anexo para mais detalhes.