Metin girişini kabul eden bir giriş alanı widget'ı.
Google Workspace Eklentileri ve Google Chat uygulamalarında kullanılabilir.
var textInput = CardService.newTextInput() .setFieldName("text_input_form_input_key") .setTitle("Text input title") .setHint("Text input hint");
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
setFieldName(fieldName) | TextInput | Bir kullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu metin girişini tanımlayan anahtarı ayarlar. |
setHint(hint) | TextInput | Metin girişi için bir ipucu ayarlar. |
setMultiline(multiline) | TextInput | Giriş metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini ayarlar. |
setOnChangeAction(action) | TextInput | Metin girişi her değiştiğinde gerçekleştirilecek bir işlem ayarlar. |
setSuggestions(suggestions) | TextInput | Metin alanında otomatik tamamlama önerilerini ayarlar. |
setSuggestionsAction(suggestionsAction) | TextInput | Otomatik tamamlama için kullanıcı girişine göre öneriler getirmek üzere geri çağırma işlemini ayarlar. |
setTitle(title) | TextInput | Giriş alanının üzerinde gösterilecek başlığı ayarlar. |
setValue(value) | TextInput | Giriş alanında ayarlanacak önceden doldurulmuş değeri ayarlar. |
Ayrıntılı belgeler
setFieldName(fieldName)
Bir kullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu metin girişini tanımlayan anahtarı ayarlar. Kullanıcı göremez. Zorunlu, benzersiz olmalıdır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
fieldName | String | Bu girişi tanımlamak için kullanılan anahtar. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setHint(hint)
Metin girişi için bir ipucu ayarlar. Kullanıcıya giriş yapması gerekenlerle ilgili ekstra rehberlik sağlamak için kullanılır. Örneğin, bir ipucu, telefon numarası alanının biçimlendirmesini ("xxx-xxx-xxxx") açıklayabilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
hint | String | Giriş alanının altında görüntülenecek metin ipucu. Bu metin her zaman görünür. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setMultiline(multiline)
Giriş metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
multiline | Boolean | Çok satırlı ayar. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setOnChangeAction(action)
setSuggestions(suggestions)
Metin alanında otomatik tamamlama önerilerini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
suggestions | Suggestions | Kullanılacak önerilerin koleksiyonu. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setSuggestionsAction(suggestionsAction)
Otomatik tamamlama için kullanıcı girişine göre öneriler getirmek üzere geri çağırma işlemini ayarlar. Action
parametresi, SuggestionsResponse
nesnesi döndüren bir geri çağırma işlevi belirtmelidir.
var action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({'numSuggestions': 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { var suggestions = CardService.newSuggestions(); var numSuggestions = parseInt(e.parameter['numSuggestions']); for(var i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion('Suggestion ' + i); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
Parametreler
Ad | Tür | Açıklama |
---|---|---|
suggestionsAction | Action | Bu giriş için önerileri getiren işlem. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setTitle(title)
Giriş alanının üzerinde gösterilecek başlığı ayarlar. Zorunlu.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
title | String | Bu giriş için metin etiketi. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.
setValue(value)
Giriş alanında ayarlanacak önceden doldurulmuş değeri ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
value | String | Girişe yerleştirilen varsayılan değer. Her zaman form geri çağırma parametrelerinde bir dize olarak temsil edilir. |
Return
TextInput
: Zincirleme için kullanılan bu nesne.