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

Class TextInput

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

אפשר להשתמש בתוספים ל-Google Workspace ובאפליקציות של Google Chat.

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`setFieldName(fieldName)`	`TextInput`	המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש.
`setHint(hint)`	`TextInput`	הגדרת רמז לקלט הטקסט.
`setMultiline(multiline)`	`TextInput`	ההגדרה הזו קובעת אם טקסט הקלט יופיע בשורה אחת או בכמה שורות.
`setOnChangeAction(action)`	`TextInput`	הגדרת פעולה שתבוצע בכל פעם שקלט הטקסט משתנה.
`setSuggestions(suggestions)`	`TextInput`	מגדיר את ההצעות להשלמה אוטומטית בשדה הטקסט.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	מגדירה את פעולת הקריאה החוזרת לאחזור הצעות על סמך קלט של משתמש להשלמה אוטומטית.
`setTitle(title)`	`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.

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

פרמטרים

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

החזרות

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

`setTitle(title)`

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

פרמטרים

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

החזרות

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

`setValue(value)`

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

פרמטרים

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

החזרות

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