דף זה תורגם על ידי Cloud Translation API.

Class TextInput

ווידג'ט של שדה קלט שמקבל קלט טקסט.

התכונה זמינה בתוספים של Google Workspace ובאפליקציות של Google Chat.

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`setFieldName(fieldName)`	`TextInput`	מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש.
`setHint(hint)`	`TextInput`	הגדרת רמז לקלט הטקסט.
`setMultiline(multiline)`	`TextInput`	מגדיר אם טקסט הקלט יוצג בשורה אחת או בכמה שורות.
`setOnChangeAction(action)`	`TextInput`	הגדרת פעולה שתתבצע בכל פעם שהטקסט שמוזן משתנה.
`setSuggestions(suggestions)`	`TextInput`	הגדרת ההצעות להשלמה אוטומטית בשדה הטקסט.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	מגדיר את פעולת הקריאה החוזרת כדי לאחזר הצעות על סמך קלט המשתמש להשלמה אוטומטית.
`setTitle(title)`	`TextInput`	הגדרת הכותרת שתוצג מעל שדה הקלט.
`setValidation(validation)`	`TextInput`	הגדרת כלל האימות של הווידג'ט הזה.
`setValue(value)`	`TextInput`	מגדיר את הערך שמוגדר מראש בשדה הקלט.

מסמכים מפורטים

`setFieldName(fieldName)`

מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש. לא גלויים למשתמש. חובה, חייב להיות ייחודי.

פרמטרים

שם	סוג	תיאור
`fieldName`	`String`	המפתח שמשמש לזיהוי הקלט הזה.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setHint(hint)`

הגדרת רמז לקלט הטקסט. משמש למתן הנחיות נוספות למשתמש לגבי הקלט. לדוגמה, אפשר לתאר בטיפים את הפורמט ('xxx-xxx-xxxx') של שדה מספר טלפון.

פרמטרים

שם	סוג	תיאור
`hint`	`String`	הטקסט של ההצעה שיוצג מתחת לשדה הקלט. הטקסט הזה תמיד גלוי.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setMultiline(multiline)`

מגדיר אם טקסט הקלט יוצג בשורה אחת או בכמה שורות.

פרמטרים

שם	סוג	תיאור
`multiline`	`Boolean`	ההגדרה של מספר שורות.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setOnChangeAction(action)`

הגדרת פעולה שתתבצע בכל פעם שהטקסט שמוזן משתנה.

פרמטרים

שם	סוג	תיאור
`action`	`Action`	הפעולה שצריך לבצע.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setSuggestions(suggestions)`

הגדרת ההצעות להשלמה אוטומטית בשדה הטקסט.

פרמטרים

שם	סוג	תיאור
`suggestions`	`Suggestions`	האוסף של ההצעות לשימוש.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setSuggestionsAction(suggestionsAction)`

מגדיר את פעולת הקריאה החוזרת כדי לאחזר הצעות על סמך קלט המשתמש להשלמה אוטומטית. הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט SuggestionsResponse.

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();
}

פרמטרים

שם	סוג	תיאור
`suggestionsAction`	`Action`	הפעולה שמאחזרת הצעות לקלט הזה.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setTitle(title)`

הגדרת הכותרת שתוצג מעל שדה הקלט. חובה.

פרמטרים

שם	סוג	תיאור
`title`	`String`	תווית הטקסט של הקלט הזה.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setValidation(validation)`

הגדרת כלל האימות של הווידג'ט הזה.

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

פרמטרים

שם	סוג	תיאור
`validation`	`Validation`	כלל האימות של הווידג'ט `TextInput`.

חזרה

TextInput – האובייקט הזה, לצורך קישור.

`setValue(value)`

מגדיר את הערך שמוגדר מראש בשדה הקלט.

פרמטרים

שם	סוג	תיאור
`value`	`String`	ערך ברירת המחדל שמופיע בקלט. הוא תמיד מיוצג כמחרוזת בפרמטרים של קריאה חוזרת (callback) של הטופס.

חזרה

TextInput – האובייקט הזה, לצורך קישור.