Metin girişini kabul eden bir giriş alanı widget'ı.
Google Workspace eklentilerinde ve Google Chat uygulamalarında kullanılabilir.
const 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 | 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 belirler. |
setMultiline(multiline) | TextInput | Giriş metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler. |
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 önerileri getirmek üzere geri çağırma işlemini ayarlar. |
setTitle(title) | TextInput | Giriş alanının üzerinde gösterilecek başlığı ayarlar. |
setValidation(validation) | TextInput | Bu widget için doğrulama kuralını belirler. |
setValue(value) | TextInput | Giriş alanına ayarlanacak önceden doldurulmuş değeri ayarlar. |
Ayrıntılı dokümanlar
setFieldName(fieldName)
Kullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu metin girişini tanımlayan anahtarı ayarlar. Kullanıcı tarafından görülemez. Zorunludur ve 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 bu nesne.
setHint(hint)
Metin girişi için bir ipucu ayarlar. Kullanıcıya ne gireceği konusunda ek 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österilecek metin ipucu. Bu metin her zaman görünür durumdadır. |
Return
TextInput
: Zincirleme için bu nesne.
setMultiline(multiline)
Giriş metninin bir satırda mı yoksa birden çok satırda mı gösterileceğini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
multiline | Boolean | Çok satırlı ayarı. |
Return
TextInput
: Zincirleme için bu nesne.
setOnChangeAction(action)
setSuggestions(suggestions)
Metin alanında otomatik tamamlama önerilerini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
suggestions | Suggestions | Kullanılacak öneriler koleksiyonu. |
Return
TextInput
: Zincirleme için bu nesne.
setSuggestionsAction(suggestionsAction)
Otomatik tamamlama için kullanıcı girişine göre önerileri getirmek üzere geri çağırma işlemini ayarlar. Action
parametresi, SuggestionsResponse
nesnesi döndüren bir geri çağırma işlevi belirtmelidir.
const action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({numSuggestions: 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { const suggestions = CardService.newSuggestions(); const numSuggestions = Number.parseInt(e.parameter.numSuggestions); for (let 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 öneriler getiren işlem. |
Return
TextInput
: Zincirleme için 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şin metin etiketi. |
Return
TextInput
: Zincirleme için bu nesne.
setValidation(validation)
Bu widget için doğrulama kuralını belirler.
const validation = CardService.newValidation().setCharacterLimit('10').setType( CardService.InputType.TEXT); const input = CardService.newTextInput() .setFieldName('text_name_xxx1') .setTitle('Max 10 characters') .setValidation(validation);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
validation | Validation | Bu TextInput widget'ı için doğrulama kuralı. |
Return
TextInput
: Zincirleme için 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. Form geri çağırma parametrelerinde her zaman dize olarak temsil edilir. |
Return
TextInput
: Zincirleme için bu nesne.