דף זה תורגם על ידי 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`	ערך ברירת המחדל שממוקם בקלט. הוא תמיד מיוצג כמחרוזת ב פרמטרים של קריאה חוזרת (callback).

חזרה

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