Class Action

İşlem

Kullanıcı arayüzü öğelerinde etkileşimi etkinleştiren bir işlem. Eylem doğrudan istemcide gerçekleşmez, bunun yerine isteğe bağlı parametrelerle bir Apps Komut Dosyası geri arama işlevini çağırır.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir.

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

Yöntemler

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

Kullanımdan kaldırılan yöntemler

Yöntem	Dönüş türü	Kısa açıklama
setMethodName(functionName)	Action

Ayrıntılı belgeler

addRequiredWidget(requiredWidget)

Bu işlemin geçerli bir gönderim için ihtiyaç duyduğu widget'ların adlarını ekler. Bu listedeki widget'lar bu işlem çağrıldığında bir değere sahip değilse form gönderimi iptal edilir.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_1')
                      .setTitle('Text input title');

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

Parametreler

Ad	Tür	Açıklama
requiredWidget	String	Bu işlem için gereken widget'ın adı.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

Bu işlemin tüm widget'lardan giriş gerektirip gerektirmediğini gösterir.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir.

// 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

Ad	Tür	Açıklama
allWidgetsAreRequired	Boolean	İşlem için tüm widget'lardan giriş yapılması gerekip gerekmediği. Varsayılan olarak false değerine ayarlanır.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setFunctionName(functionName)

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

Parametreler

Ad	Tür	Açıklama
functionName	String	İşlevin adı. Library.libFunction1 gibi dahil edilen kitaplıklardaki işlevleri kullanabilirsiniz.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setInteraction(interaction)

Kullanıcıyla etkileşimi ayarlar. Yalnızca iletişim kutusu açılırken gereklidir. Belirtilmediyse uygulama, normalde olduğu gibi bir bağlantıyı açma veya bir işlevi çalıştırma gibi bir Action işlemi yaparak yanıt verir.

Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileri için kullanılamaz.

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

Parametreler

Ad	Tür	Açıklama
interaction	Interaction	Belirtilecek etkileşim.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setLoadIndicator(loadIndicator)

İşlem devam ederken gösterilen yükleme göstergesini ayarlar.

Parametreler

Ad	Tür	Açıklama
loadIndicator	LoadIndicator	Gösterilecek gösterge.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setParameters(parameters)

Özel parametrelerin geri çağırma işlevine iletilmesine olanak tanır. İsteğe bağlı.

Parametreler

Ad	Tür	Açıklama
parameters	Object	Hem anahtarlar hem de değerler dize olmalıdır.

Return

Action: Zincirleme için kullanılan bu nesne.

---

setPersistValues(persistValues)

Bir işlem yanıtı, formun Card özelliğini güncelledikten sonra form değerlerinin istemcinin değerleriyle mi yoksa sunucunun değerleriyle mi belirlendiğini gösterir. true olarak ayarlandığında, istemcinin değerleri sunucu yanıtından sonra kalıcı olur. false olarak ayarlandığında sunucunun değerleri, form değerlerinin üzerine yazar. Varsayılan olarak false değerine ayarlanır.

İstemci değerlerinin kalıcı hale getirilmesi, kullanıcının düzenleme yapmasının ardından formun beklenmedik şekilde değişmesini önlemeye yardımcı olur. Örneğin, bir kullanıcı form gönderdikten sonra ancak sunucu yanıt vermeden önce TextInput üzerinde düzenleme yaparsa. Değerler kalıcı hale getirilirse kullanıcının yaptığı düzenleme, sunucu yanıtı Card değerini güncelledikten sonra da kalır. Aksi takdirde form değeri, kullanıcının başlangıçta forma gönderdiği değere geri döner.

İstemci değerlerinin kalıcı olması, komut dosyanızın form alanlarını temizleme veya form değerlerini geçersiz kılma özelliğini etkileyebilir. Bu nedenle, bu tür işlevler için kalıcılığı etkinleştirmeyin. Kalıcılık olmadan, etkinlikler için LoadIndicator.SPINNER kullanmanız önerilir. Bu, kullanıcı arayüzünü kilitler ve sunucu yanıt vermeden önce kullanıcı düzenlemelerini engeller. Alternatif olarak, LoadIndicator.NONE kullanabilir ve formdaki her öğenin onChange işlemi olduğundan emin olabilirsiniz.

// 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

Ad	Tür	Açıklama
persistValues	Boolean	Değerlerin kalıcı olup olmayacağı. Varsayılan olarak false değerine ayarlanır.

Return

Action: Zincirleme için kullanılan bu nesne.

Kullanımdan kaldırılan yöntemler

setMethodName(functionName)

Kullanımdan kaldırıldı. setFunctionName(functionName) için eski takma ad.

Parametreler

Ad	Tür	Açıklama
functionName	String	İşlevin adı. Library.libFunction1 gibi dahil edilen kitaplıklardaki işlevleri kullanabilirsiniz.

Return

Action: Zincirleme için kullanılan bu nesne.