Class TextInput

קלטטקסט

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

יש תמיכה באימות של שליחת טפסים. אם Action.setAllWidgetsAreRequired(allWidgetsAreRequired) מוגדר ל-true או שהווידג'ט הזה מצוין באמצעות Action.addRequiredWidget(requiredWidget), פעולת השליחה נחסמת אלא אם מוזן ערך.

זמין לתוספים ל-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הגדרת רמז לקלט הטקסט.
setHostAppDataSource(hostAppDataSource)TextInputהפונקציה מגדירה מקור נתונים מאפליקציות של Google Workspace.
setMultiline(multiline)TextInputקובע אם טקסט הקלט מוצג בשורה אחת או בכמה שורות.
setOnChangeAction(action)TextInputהגדרת פעולה שתתבצע בכל פעם שמשנים את קלט הטקסט.
setSuggestions(suggestions)TextInputהגדרת ההצעות להשלמה אוטומטית בשדה הטקסט.
setSuggestionsAction(suggestionsAction)TextInputמגדיר את פעולת הקריאה החוזרת לאחזור הצעות על סמך קלט המשתמש להשלמה אוטומטית.
setTitle(title)TextInputמגדיר את הכותרת שתוצג מעל שדה הקלט.
setValidation(validation)TextInputהגדרת כלל האימות לווידג'ט הזה.
setValue(value)TextInputמגדיר את הערך שיוזן מראש בשדה הקלט.

תיעוד מפורט

setFieldName(fieldName)

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

פרמטרים

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

חזרה

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


setHint(hint)

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

פרמטרים

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

חזרה

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


setHostAppDataSource(hostAppDataSource)

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

האפשרות הזו זמינה רק דרך תוכנית Gemini אלפא לתוספים של Google Workspace שמרחיבים את האפשרויות של Google Workspace Flows.

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

פרמטרים

שםסוגתיאור
hostAppDataSourceHostAppDataSourceמקור הנתונים.

חזרה

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


setMultiline(multiline)

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

פרמטרים

שםסוגתיאור
multilineBooleanההגדרה של שורות מרובות.

חזרה

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


setOnChangeAction(action)

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

פרמטרים

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

חזרה

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


setSuggestions(suggestions)

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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


setTitle(title)

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

פרמטרים

שםסוגתיאור
titleStringתווית הטקסט של הקלט הזה.

חזרה

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

פרמטרים

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

חזרה

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


setValue(value)

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

פרמטרים

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

חזרה

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