Class TextInput

MetinGirişi

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

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öntemDönüş türüKısa açıklama
setFieldName(fieldName)TextInputKullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu metin girişini tanımlayan anahtarı ayarlar.
setHint(hint)TextInputMetin girişi için bir ipucu belirler.
setMultiline(multiline)TextInputGiriş metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.
setOnChangeAction(action)TextInputMetin girişi her değiştiğinde gerçekleştirilecek bir işlem ayarlar.
setSuggestions(suggestions)TextInputMetin alanında otomatik tamamlama önerilerini ayarlar.
setSuggestionsAction(suggestionsAction)TextInputGeri çağırma işlemini, otomatik tamamlama için kullanıcı girişine göre öneriler alacak şekilde ayarlar.
setTitle(title)TextInputGiriş alanının üzerinde gösterilecek başlığı ayarlar.
setValidation(validation)TextInputBu widget için doğrulama kuralını belirler.
setValue(value)TextInputGiriş 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. Zorunlu, benzersiz olmalıdır.

Parametreler

AdTürAçıklama
fieldNameStringBu 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 belirler. 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

AdTürAçıklama
hintStringGiriş 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 tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.

Parametreler

AdTürAçıklama
multilineBooleanÇok satırlık ayar.

Return

TextInput: Zincirleme için bu nesne.


setOnChangeAction(action)

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

Parametreler

AdTürAçıklama
actionActionYapılacak işlem.

Return

TextInput: Zincirleme için bu nesne.


setSuggestions(suggestions)

Metin alanında otomatik tamamlama önerilerini ayarlar.

Parametreler

AdTürAçıklama
suggestionsSuggestionsKullanılacak öneriler koleksiyonu.

Return

TextInput: Zincirleme için bu nesne.


setSuggestionsAction(suggestionsAction)

Geri çağırma işlemini, otomatik tamamlama için kullanıcı girişine göre öneriler alacak ş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

AdTürAçıklama
suggestionsActionActionBu 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

AdTürAçıklama
titleStringBu 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

AdTürAçıklama
validationValidationBu TextInput widget'ının doğrulama kuralı.

Return

TextInput: Zincirleme için bu nesne.


setValue(value)

Giriş alanına ayarlanacak önceden doldurulmuş değeri ayarlar.

Parametreler

AdTürAçıklama
valueStringGiriş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.