Class Action

İşlem

Kullanıcı arayüzü öğelerinde etkileşimi etkinleştiren bir işlem. İşlem doğrudan istemcide gerçekleşmez. Bunun yerine, isteğe bağlı parametrelerle bir Apps Komut Dosyası geri arama işlevi çağrılı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	Geçerli bir gönderim için bu işlemin ihtiyaç duyduğu widget'ların adlarını ekler.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	Bu iş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)	Action	Kullanıcıyla etkileşimi belirler. Yalnızca iletişim kutusu açarken gereklidir.
setLoadIndicator(loadIndicator)	Action	İşlem devam ederken gösterilen yükleme göstergesini ayarlar.
setParameters(parameters)	Action	Geri çağırma işlevine özel parametrelerin iletilmesine olanak tanır.
setPersistValues(persistValues)	Action	Bir işlem yanıtı formun Card değerini güncelledikten sonra form değerlerinin istemcinin değerlerine mi yoksa sunucunun değerlerine mi göre belirleneceğini belirtir.

Kullanımdan kaldırılan yöntemler

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

Ayrıntılı dokümanlar

addRequiredWidget(requiredWidget)

Geçerli bir gönderim için bu işlemin ihtiyaç duyduğu widget'ların adlarını ekler. Bu işlem çağrıldığında bu listedeki widget'ların değeri yoksa 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 bu nesne.

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

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

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	İşlemin tüm widget'lardan giriş gerektirip gerektirmediği. Varsayılan olarak false değerine ayarlanır.

Return

Action: Zincirleme için 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ı. Dahil edilen kitaplıklardaki işlevleri (ör. Library.libFunction1) kullanabilirsiniz.

Return

Action: Zincirleme için bu nesne.

---

setInteraction(interaction)

Kullanıcıyla etkileşimi belirler. Yalnızca iletişim kutusu açarken gereklidir. Belirtilmemişse uygulama, normalde olduğu gibi bir bağlantı açma veya işlev çalıştırma gibi bir Action yürüterek yanıt verir.

Yalnızca Google Chat uygulamaları için kullanılabilir. Google Workspace eklentilerinde 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 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 bu nesne.

---

setParameters(parameters)

Geri çağırma işlevine özel parametrelerin 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 bu nesne.

---

setPersistValues(persistValues)

Bir işlem yanıtı formun Card değerini güncelledikten sonra form değerlerinin istemcinin değerlerine mi yoksa sunucunun değerlerine mi göre belirleneceğini belirtir. true olarak ayarlandığında istemcinin değerleri sunucu yanıtından sonra devam eder. false olarak ayarlandığında, sunucunun değerleri form değerlerinin üzerine yazılır. Varsayılan olarak false değerine ayarlanır.

İstemci değerlerini korumak, kullanıcı bir düzenleme yaptıktan sonra formun beklenmedik şekilde değiştiği durumları önlemeye yardımcı olur. Örneğin, bir kullanıcı form gönderdikten sonra ancak sunucu yanıt vermeden önce TextInput öğesinde düzenleme yaparsa. Değerler kalıcıysa sunucu yanıtı Card değerini güncelledikten sonra kullanıcının yaptığı düzenleme korunur. 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ı 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ştirmekten kaçının. Kalıcı olmayan 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 öğesini kullanabilir ve formdaki her öğenin onChange işlemine sahip 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 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ı. Dahil edilen kitaplıklardaki işlevleri (ör. Library.libFunction1) kullanabilirsiniz.

Return

Action: Zincirleme için bu nesne.