Działania w kalendarzu

Obiekty Action umożliwiają tworzenie interaktywnych funkcji w dodatkach do Google Workspace. Określają, co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Działanie jest dołączane do danego widżetu za pomocą funkcji obsługi widżetu, która określa też warunek wywołujący działanie. Po wywołaniu działanie wykonuje wyznaczoną funkcję wywołania zwrotnego. Funkcja wywołania zwrotnego otrzymuje obiekt zdarzenia, który zawiera informacje o interakcjach użytkownika po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i sprawić, aby zwracała określony obiekt odpowiedzi.

Załóżmy na przykład, że chcesz utworzyć przycisk, który po kliknięciu tworzy i wyświetla nową kartę. W tym celu musisz utworzyć nowy widżet przycisku i użyć funkcji obsługi widżetu przycisku setOnClickAction(action), aby ustawić Action tworzenia karty. Zdefiniowany przez Ciebie element Action określa funkcję zwrotną Apps Script, która jest wykonywana po kliknięciu przycisku. W takim przypadku implementujesz funkcję zwrotną, aby utworzyć żądaną kartę, i zwracasz obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, że ma wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

Na tej stronie opisujemy działania widżetów Kalendarza, które możesz uwzględnić w dodatku.

Interakcje z kalendarzem

Dodatki do Google Workspace, które rozszerzają Kalendarz, mogą zawierać kilka dodatkowych działań widżetów specyficznych dla Kalendarza. Te działania wymagają, aby powiązana z nimi funkcja wywołania zwrotnego zwracała specjalne obiekty odpowiedzi:

Podjęte działanie Funkcja wywołania zwrotnego powinna zwracać
Dodawanie uczestników CalendarEventActionResponse
Ustawianie danych konferencji CalendarEventActionResponse
Dodawanie załączników CalendarEventActionResponse

Aby korzystać z tych działań widżetu i obiektów odpowiedzi, muszą być spełnione wszystkie te warunki:

  • Działanie jest wywoływane, gdy użytkownik ma otwarte wydarzenie w Kalendarzu.
  • Pole manifestu dodatku addOns.calendar.currentEventAccess jest ustawione na WRITE lub READ_WRITE.
  • Dodatek zawiera https://www.googleapis.com/auth/calendar.addons.current.event.write zakres Kalendarza.

Ponadto wszelkie zmiany wprowadzone przez funkcję wywołania zwrotnego działania nie są zapisywane, dopóki użytkownik nie zapisze wydarzenia w Kalendarzu.

Dodawanie uczestników za pomocą funkcji wywołania zwrotnego

Poniższy przykład pokazuje, jak utworzyć przycisk, który dodaje konkretnego uczestnika do edytowanego wydarzenia w Kalendarzu:

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

Ustawianie danych konferencji za pomocą funkcji wywołania zwrotnego

Ta czynność ustawia dane konferencji w otwartym wydarzeniu. W przypadku tych danych o konferencji należy podać identyfikator rozwiązania konferencyjnego, ponieważ działanie nie zostało wywołane przez użytkownika, który wybrał odpowiednie rozwiązanie.

Poniższy przykład pokazuje, jak utworzyć przycisk, który ustawia dane konferencji dla edytowanego wydarzenia:

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

Dodawanie załączników za pomocą funkcji wywołania zwrotnego

Poniższy przykład pokazuje, jak utworzyć przycisk, który dodaje załącznik do edytowanego wydarzenia w Kalendarzu:

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

Ustawianie ikony załącznika

Ikona załącznika musi być hostowana w infrastrukturze Google. Więcej informacji znajdziesz w sekcji Podawanie ikon załączników.