Class Action

İşlem

Kullanıcı arayüzü öğeleri içinde etkileşim kurmayı sağlayan bir işlem. Bu işlem doğrudan Apps Komut Dosyası geri çağırma işlevini çağırır. parametresini kullanabilirsiniz.

Google Workspace eklentilerinde ve Google Chat uygulamalarında kullanılabilir.

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

Yöntemler

YöntemDönüş türüKısa açıklama
addRequiredWidget(requiredWidget)ActionBu İşlemin geçerli bir gönderim için ihtiyaç duyduğu widget'ların adlarını ekler.
setAllWidgetsAreRequired(allWidgetsAreRequired)ActionBu İşlemin tüm widget'lardan giriş gerektirip gerektirmediğini belirtir.
setFunctionName(functionName)ActionÇağrılacak geri çağırma işlevinin adını ayarlar.
setInteraction(interaction)ActionKullanıcıyla etkileşimi ayarlar. Yalnızca iletişim kutusu açılırken gereklidir.
setLoadIndicator(loadIndicator)Actionİşlem devam ederken görüntülenen yükleme göstergesini ayarlar.
setParameters(parameters)ActionÖzel parametrelerin geri çağırma işlevine aktarılmasını sağlar.
setPersistValues(persistValues)ActionForm değerlerinin istemcinin değerleriyle mi yoksa sunucunun değerleriyle mi belirlendiğini belirtir. yanıtından sonra formun Card özelliği güncellendi.

Ayrıntılı belgeler

addRequiredWidget(requiredWidget)

Bu İşlemin geçerli bir gönderim için ihtiyaç duyduğu widget'ların adlarını ekler. Widget'lar bu İşlem çağrıldığında bu listenin bir değeri yok, form gönderme işlemi iptal edildi.

Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileriyle kullanılamaz.

var textInput = CardService.newTextInput()
    .setFieldName("text_input_1")
    .setTitle("Text input title")

// Creates a footer button that requires an input from the above TextInput Widget.
var action = CardService.newAction()
    .setFunctionName("notificationCallback")
    .addRequiredWidget("text_input_1");
var fixedFooter =
      CardService
          .newFixedFooter()
          .setPrimaryButton(
              CardService
                  .newTextButton()
                  .setText("help")
                  .setOnClickAction(action));

Parametreler

AdTürAçıklama
requiredWidgetStringBu İşlem için gereken widget'ın adı.

Return

Action: Zincirleme için bu nesne.


setAllWidgetsAreRequired(allWidgetsAreRequired)

Bu İşlemin tüm widget'lardan giriş gerektirip gerektirmediğini belirtir.

Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileriyle kullanılamaz.

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setAllWidgetsAreRequired(true));

Parametreler

AdTürAçıklama
allWidgetsAreRequiredBooleanİşlemin tüm widget'lardan giriş gerektirip gerektirmediği. Varsayılan değer: false

Return

Action: Zincirleme için bu nesne.


setFunctionName(functionName)

Çağrılacak geri çağırma işlevinin adını ayarlar. Zorunlu.

Parametreler

AdTürAçıklama
functionNameStringİşlevin adı. Dahil edilen kitaplıklardaki işlevleri, Library.libFunction1 gibi.

Return

Action: Zincirleme için bu nesne.


setInteraction(interaction)

Kullanıcıyla etkileşimi ayarlar. Yalnızca iletişim kutusu açılırken gereklidir. Belirtilmemişse uygulama normal şekilde bağlantı açmak veya bir işlev çalıştırmak gibi bir Action yürüterek yanıt verir.

Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileriyle kullanılamaz.

const action = CardService.newAction()
    .setFunctionName('handleDialog')
    .setInteraction(CardService.Interaction.OPEN_DIALOG);

Parametreler

AdTürAçıklama
interactionInteractionBelirtilecek etkileşim.

Return

Action: Zincirleme için bu nesne.


setLoadIndicator(loadIndicator)

İşlem devam ederken görüntülenen yükleme göstergesini ayarlar.

Parametreler

AdTürAçıklama
loadIndicatorLoadIndicatorGösterilecek gösterge.

Return

Action: Zincirleme için bu nesne.


setParameters(parameters)

Özel parametrelerin geri çağırma işlevine aktarılmasını sağlar. İsteğe bağlı.

Parametreler

AdTürAçıklama
parametersObjectHem anahtarlar hem de değerler dize olmalıdır.

Return

Action: Zincirleme için bu nesne.


setPersistValues(persistValues)

Form değerlerinin istemcinin değerleriyle mi yoksa sunucunun değerleriyle mi belirlendiğini belirtir. yanıtından sonra formun Card özelliği güncellendi. true olarak ayarlandığında İstemcinin değerleri sunucu yanıtından sonra da korunur. false olarak ayarlandığında sunucunun değerleri, form değerlerinin üzerine yazar. Varsayılan olarak false değerine ayarlanır.

İstemci değerlerinin korunması, bir formun beklenmedik şekilde değiştiği durumları önlemeye yardımcı olur Kullanıcı düzenleme yaptıktan sonra. Örneğin, bir kullanıcı 24 saat sonra TextInput ancak sunucunun yanıt vermemesi gerekir. Değerler korunursa, sunucu yanıtı Card öğesini güncelledikten sonra kullanıcı tarafından yapılan değişiklikler; Aksi takdirde, form değeri kullanıcının forma ilk gönderdiği değere döner.

İstemci değerlerinin kalıcı olması, komut dosyanızın form alanlarını temizlemesini engelleyebilir veya Form değerlerini geçersiz kıldığınızdan bu tür işlevler için kalıcılığı etkinleştirmekten kaçının. Yok: sebat varsa etkinlikler için LoadIndicator.SPINNER kullanmanız önerilir. Çünkü bu işlem kullanıcı arayüzünü kilitler ve sunucu yanıt vermeden önce kullanıcıların düzenlemelerini engeller. Alternatif olarak: LoadIndicator.NONE kullanabilir ve formdaki her öğenin onChange öğesinin bulunduğundan emin olabilirsiniz eyleme dökülebilir.

// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setPersistValues(true)
            .setFunctionName('functionName'));

Parametreler

AdTürAçıklama
persistValuesBooleanDeğerlerin sürdürülüp sürdürülmeyeceği. Varsayılan olarak false değerine ayarlanır.

Return

Action: Zincirleme için bu nesne.

Desteği sonlandırılan yöntemler