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 çağırma işlevi çağırır.
Google Workspace Eklentileri ve Google Chat uygulamalarında kullanılabilir.
var image = CardService.newImage()
.setOnClickAction(CardService.newAction()
.setFunctionName("handleImageClick")
.setParameters({imageSrc: 'carImage'}));
Yöntemler
| Yöntem | Dönüş türü | Kısa açıklama |
|---|---|---|
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örüntülenen yükleme göstergesini ayarlar. |
setParameters(parameters) | Action | Özel parametrelerin geri çağırma işlevine iletilmesine izin verir. |
setPersistValues(persistValues) | Action | Bir işlem yanıtı formun Card değeri güncellendikten sonra form değerlerinin istemci değerleriyle mi yoksa sunucu değerleriyle mi belirlendiğini belirtir. |
Ayrıntılı belgeler
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 kullanılan bu nesne.
setInteraction(interaction)
Kullanıcıyla etkileşimi ayarlar (yalnızca iletişim kutusu açılırken gereklidir). Belirtilmemişse uygulama, normal şekilde bir bağlantıyı açma veya bir işlevi çalıştırma gibi bir Action yürüterek 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örüntülenen 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 izin verir. İ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 değeri güncellendikten sonra form değerlerinin istemci değerleriyle mi yoksa sunucu değerleriyle mi belirlendiğini belirtir. true olarak ayarlandığında istemcinin değerleri sunucu yanıtından sonra 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ı, kullanıcı bir düzenleme yaptıktan sonra formun beklenmedik bir şekilde değiştiği durumları önlemeye yardımcı olur. Örneğin, bir kullanıcı form gönderdikten sonra, sunucu yanıt vermeden önce TextInput üzerinde bir düzenleme yaparsa. Değerler kalıcı olursa kullanıcının yaptığı düzenleme, sunucu yanıtı Card bilgisini güncelledikten sonra da kalır. Aksi takdirde, form değeri kullanıcının forma ilk gönderdiği değere döner.
Kalıcı istemci değerleri, komut dosyanızın form alanlarını temizlemesini veya form değerlerini geçersiz kılmasını engelleyebilir. Bu nedenle, bu işlev türü için kalıcılığı etkinleştirmekten kaçının. 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ının düzenlemelerini engeller. Alternatif olarak, LoadIndicator.NONE kullanabilir ve formdaki her öğenin bir 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 korunup korunmayacağı. Varsayılan olarak false değerine ayarlanır. |
Return
Action: Zincirleme için kullanılan bu nesne.