Class TextInput

TextInput

Metin girişini kabul eden bir giriş alanı widget'ı.

Form gönderimi doğrulamayı destekler. Action.setAllWidgetsAreRequired(allWidgetsAreRequired), true olarak ayarlandığında veya bu widget Action.addRequiredWidget(requiredWidget) aracılığıyla belirtildiğinde, değer girilmediği sürece gönderme işlemi engellenir.

Google Workspace eklentileri ve Google Chat uygulamaları için 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
addEventAction(eventAction)	Widget	Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.
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 ipucu ayarlar.
setHostAppDataSource(hostAppDataSource)	TextInput	Google Workspace uygulamalarından bir veri kaynağı ayarlar.
setId(id)	Widget	Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar.
setInputMode(inputMode)	TextInput	Bu metin girişi alanının değişken eklemeyi destekleyip desteklemediğini 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	Geri çağırma işlemini, otomatik tamamlama için kullanıcı girişine dayalı önerileri getirecek şekilde ayarlar.
setTitle(title)	TextInput	Başlığı, giriş alanının üzerinde gösterilecek şekilde ayarlar.
setValidation(validation)	TextInput	Bu widget için doğrulama kuralını ayarlar.
setValue(value)	TextInput	Giriş alanında ayarlanacak önceden doldurulmuş değeri belirler.
setVisibility(visibility)	Widget	Widget'ın görünürlüğünü ayarlar.

Ayrıntılı belgeler

addEventAction(eventAction)

Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.

Parametreler

Ad	Tür	Açıklama
eventAction	EventAction	Eklenecek EventAction.

Return

Widget: Zincirleme için kullanılan nesne.

---

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

Return

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

---

setHostAppDataSource(hostAppDataSource)

Google Workspace uygulamalarından bir veri kaynağı ayarlar. Şu anda kullanıcıları ve Chat alanlarını desteklemektedir.

Yalnızca Google Workspace Studio'yu genişleten Google Workspace eklentileri için kullanılabilir.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Parametreler

Ad	Tür	Açıklama
hostAppDataSource	HostAppDataSource	Veri kaynağı.

Return

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

---

setId(id)

Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. Widget mutasyonu yalnızca eklentilerde desteklenir.

Parametreler

Ad	Tür	Açıklama
id	String	64 karakterle sınırlı ve "[a-zA-Z0-9-]+" biçiminde olan widget'ın kimliği.

Return

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

---

setInputMode(inputMode)

Bu metin girişi alanının değişken eklemeyi destekleyip desteklemediğini ayarlar.

Yalnızca Google Workspace Studio'yu genişleten Google Workspace eklentileri için kullanılabilir.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Parametreler

Ad	Tür	Açıklama
inputMode	TextInputMode	Bu metin girişi alanında izin verilen giriş türü. Değişken eklemeyi desteklemek için RICH_TEXT'i kullanın.

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)

Metin girişi her değiştiğinde gerçekleştirilecek bir işlem ayarlar.

Parametreler

Ad	Tür	Açıklama
action	Action	Yapılacak işlem.

Return

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

---

setSuggestions(suggestions)

Metin alanında otomatik tamamlama önerilerini ayarlar.

Parametreler

Ad	Tür	Açıklama
suggestions	Suggestions	Kullanılacak öneri koleksiyonu.

Return

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

---

setSuggestionsAction(suggestionsAction)

Geri çağırma işlemini, otomatik tamamlama için kullanıcı girişine dayalı önerileri getirecek şekilde 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 önerileri getiren işlem.

Return

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

---

setTitle(title)

Başlığı, giriş alanının üzerinde gösterilecek şekilde ayarlar. Zorunlu.

Parametreler

Ad	Tür	Açıklama
title	String	Bu girişin metin etiketi.

Return

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

---

setValidation(validation)

Bu widget için doğrulama kuralını ayarlar.

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'ının doğrulama kuralı.

Return

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

---

setValue(value)

Giriş alanında ayarlanacak önceden doldurulmuş değeri belirler.

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 gösterilir.

Return

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

---

setVisibility(visibility)

Widget'ın görünürlüğünü ayarlar. Varsayılan değer "VISIBLE"dır.

Parametreler

Ad	Tür	Açıklama
visibility	Visibility	Widget'ın Visibility.

Return

Widget: Zincirleme için kullanılan nesne.