Kalenderaktionen

Mit Action-Objekten können Sie interaktive Elemente Google Workspace-Add-ons. Sie definieren was passiert, wenn Nutzende mit einem Widget (z. B. einer Schaltfläche) in der Add-on-Benutzeroberfläche.

Eine Aktion wird mithilfe eines widget-Handler-Funktion, definiert auch die Bedingung, die die Aktion auslöst. Wenn der Parameter ausgelöst wird, einer bestimmten Aktion eine bestimmte Callback-Funktion verfügbar. Der Callback-Funktion wird ein Ereignisobjekt, das Informationen zu den clientseitigen Interaktionen des Nutzers. Sie müssen die Callback-Funktion an, die ein bestimmtes Antwortobjekt zurückgibt.

Angenommen, Sie möchten eine Schaltfläche, die beim Erstellen und Anzeigen einer neuen Karte angeklickt wurde. Dazu müssen Sie ein neues Schaltflächen-Widget erstellen und das Schaltflächen-Widget Handler-Funktion setOnClickAction(action) um eine Karte zum Erstellen von Action festzulegen. Die Mit Action, den Sie definieren, wird ein Apps Script angegeben -Callback-Funktion, die beim Klicken auf die Schaltfläche ausgeführt wird. In diesem Fall Implementieren Sie die Callback-Funktion, um die gewünschte Karte zu erstellen und eine ActionResponse -Objekt enthält. Das Antwortobjekt weist das Add-on an, die Karte anzuzeigen, die der Callback enthält. erstellt.

Auf dieser Seite werden spezifische Kalender-Widget-Aktionen beschrieben, die Sie in Ihrem Add-on.

Kalenderinteraktionen

Google Workspace-Add-ons, die Google Kalender erweitern kann einige zusätzliche Kalender-Widget-Aktionen enthalten. Diese Aktionen Die zugehörige Callback-Funktion ist erforderlich. um spezielle Antwortobjekte zurückzugeben:

Aktion versucht Die Callback-Funktion sollte Folgendes zurückgeben:
Teilnehmer hinzufügen CalendarEventActionResponse
Konferenzdaten festlegen CalendarEventActionResponse
Anhänge hinzufügen CalendarEventActionResponse

Um diese Widgetaktionen und Antwortobjekte zu verwenden, muss wahr sein:

  • Die Aktion wird ausgelöst, während der Nutzer einen Kalendertermin geöffnet hat.
  • Das addOns.calendar.currentEventAccess des Add-ons Das Manifest-Feld ist auf WRITE oder READ_WRITE festgelegt.
  • Das Add-on enthält die https://www.googleapis.com/auth/calendar.addons.current.event.write Kalenderumfang.

Außerdem werden durch die Aktionsrückruffunktion vorgenommene Änderungen erst gespeichert, Der Nutzer speichert den Kalendertermin.

Teilnehmer mit einer Rückruffunktion hinzufügen

Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der ein bestimmtes Teilnehmer eines Kalendertermins, der bearbeitet wird:

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

Konferenzdaten mit einer Callback-Funktion festlegen

Dadurch werden die Konferenzdaten für den offenen Termin festgelegt. Für diese Konferenzdaten Die Konferenzlösungs-ID muss angegeben werden, da die Aktion nicht die durch den Nutzer ausgelöst wird, der die gewünschte Lösung auswählt.

Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, die Konferenzdaten festlegt für ein Ereignis in Bearbeitung:

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

Anhänge mit einer Callback-Funktion hinzufügen

Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der ein Anhang Kalendertermin in Bearbeitung:

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

Festlegen des Anhangssymbols

Das Symbol für Anhänge muss in der Infrastruktur von Google gehostet werden. Siehe Bereitstellen Symbole für Anhänge .