Takvim işlemleri

Action nesneleri, Google Workspace eklentilerine etkileşimli davranışlar eklemenize olanak tanır. Bu işlevler, kullanıcı eklenti kullanıcı arayüzündeki bir widget'la (ör. düğme) etkileşimde bulunduğunda ne olacağını tanımlar.

İşlem, belirli bir widget'a widget işleyici işlevi kullanılarak eklenir. Bu işlev, işlemi tetikleyen koşulu da tanımlar. İşlem tetiklendiğinde, belirlenen bir geri çağırma işlevi yürütülür. Geri çağırma işlevine, kullanıcının istemci tarafındaki etkileşimleriyle ilgili bilgileri taşıyan bir etkinlik nesnesi iletilir. Geri çağırma işlevini uygulamanız ve belirli bir yanıt nesnesi döndürmesini sağlamanız gerekir.

Örneğin, tıklandığında yeni bir kart oluşturan ve görüntüleyen bir düğme istediğinizi varsayalım. Bunun için yeni bir düğme widget'ı oluşturmanız ve kart oluşturma Action işlemini ayarlamak için düğme widget'ı işleyici işlevini setOnClickAction(action) kullanmanız gerekir. Tanımladığınız Action, düğme tıklandığında yürütülecek bir Apps Script geri çağırma işlevi belirtir. Bu durumda, istediğiniz kartı oluşturmak ve bir ActionResponse nesnesi döndürmek için geri çağırma işlevini uygularsınız. Yanıt nesnesi, eklentiye geri çağırma işlevinin oluşturduğu kartı göstermesini söyler.

Bu sayfada, eklentinize ekleyebileceğiniz Takvim'e özgü widget işlemleri açıklanmaktadır.

Takvim etkileşimleri

Takvim'i genişleten Google Workspace eklentileri, Takvim'e özel birkaç widget işlemi içerebilir. Aşağıdaki işlemler için ilişkili işlem geri çağırma işlevinin özel yanıt nesneleri döndürmesi gerekir:

İşlem deneniyor Geri çağırma işlevi şunu döndürmelidir:
Katılımcı ekleme CalendarEventActionResponse
Konferans verilerini ayarlama CalendarEventActionResponse
Dosya ekleme CalendarEventActionResponse

Bu widget işlemlerini ve yanıt nesnelerini kullanmak için aşağıdakilerin tümü doğru olmalıdır:

  • İşlem, kullanıcının açık bir Takvim etkinliği olduğunda tetiklenir.
  • Eklentinin addOns.calendar.currentEventAccess manifest alanı WRITE veya READ_WRITE olarak ayarlanmıştır.
  • Eklenti, https://www.googleapis.com/auth/calendar.addons.current.event.write Takvim kapsamını içerir.

Ayrıca, işlem geri çağırma işlevi tarafından yapılan değişiklikler, kullanıcı takvim etkinliğini kaydedene kadar kaydedilmez.

Geri arama işleviyle katılımcı ekleme

Aşağıdaki örnekte, düzenlenmekte olan bir Takvim etkinliğine belirli bir katılımcıyı ekleyen bir düğmenin nasıl oluşturulacağı gösterilmektedir:

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

Geri çağırma işleviyle konferans verilerini ayarlama

Bu işlem, açık etkinlikte konferans verilerini ayarlar. İşlem, kullanıcının istediği çözümü seçmesiyle tetiklenmediğinden bu konferans verileri için konferans çözümü kimliğinin belirtilmesi gerekir.

Aşağıdaki örnekte, düzenlenmekte olan bir etkinlik için konferans verilerini ayarlayan bir düğmenin nasıl oluşturulacağı gösterilmektedir:

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

Geri çağırma işleviyle ek ekleme

Aşağıdaki örnekte, düzenlenmekte olan bir Takvim etkinliğine ek ekleyen bir düğmenin nasıl oluşturulacağı gösterilmektedir:

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

Ek simgesini ayarlama

Ek simgesi Google'ın altyapısında barındırılmalıdır. Ayrıntılar için Ek simgeleri sağlama başlıklı makaleyi inceleyin.