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

שיטה	סוג הערך שמוחזר	תיאור קצר
`addEventAction(eventAction)`	`Widget`	מוסיף את פעולת האירוע שאפשר לבצע בווידג'ט.
`setFieldName(fieldName)`	`TextInput`	מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשמתבצעת אינטראקציה עם ממשק המשתמש.
`setHint(hint)`	`TextInput`	מגדירה רמז לקלט הטקסט.
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	הגדרת מקור נתונים מאפליקציות של Google Workspace.
`setId(id)`	`Widget`	מגדיר את המזהה הייחודי שהוקצה לשימוש בזיהוי הווידג'ט שצריך לשנות.
`setInputMode(inputMode)`	`TextInput`	הגדרה של האפשרות להוסיף משתנים בשדה הזה להזנת קלט.
`setMultiline(multiline)`	`TextInput`	הגדרה של הצגת טקסט הקלט בשורה אחת או בכמה שורות.
`setOnChangeAction(action)`	`TextInput`	הגדרה של פעולה שתתבצע בכל פעם שמשנים את קלט הטקסט.
`setSuggestions(suggestions)`	`TextInput`	מגדיר את ההצעות להשלמה אוטומטית בשדה הטקסט.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	מגדיר את פעולת הקריאה החוזרת לאחזור הצעות על סמך קלט של משתמשים להשלמה אוטומטית.
`setTitle(title)`	`TextInput`	מגדיר את הכותרת שתוצג מעל שדה להזנת קלט.
`setValidation(validation)`	`TextInput`	הגדרת כלל האימות לווידג'ט הזה.
`setValue(value)`	`TextInput`	מגדיר את הערך שיוזן מראש בשדה להזנת קלט.
`setVisibility(visibility)`	`Widget`	ההגדרה הזו קובעת את רמת החשיפה של הווידג'ט.

תיעוד מפורט

`addEventAction(eventAction)`

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

פרמטרים

שם	סוג	תיאור
`eventAction`	`EventAction`	ה-`EventAction` שרוצים להוסיף.

חזרה

‫Widget – האובייקט, לשרשור.

`setFieldName(fieldName)`

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

פרמטרים

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

חזרה

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

`setHint(hint)`

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

פרמטרים

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

חזרה

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

`setHostAppDataSource(hostAppDataSource)`

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

האפשרות הזו זמינה רק לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio.

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

פרמטרים

שם	סוג	תיאור
`hostAppDataSource`	`HostAppDataSource`	מקור הנתונים.

חזרה

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

`setId(id)`

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

פרמטרים

שם	סוג	תיאור
`id`	`String`	המזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט [a-zA-Z0-9-]+.

חזרה

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

`setInputMode(inputMode)`

הגדרה של האפשרות להוסיף משתנים בשדה הזה להזנת קלט.

האפשרות הזו זמינה רק לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

פרמטרים

שם	סוג	תיאור
`inputMode`	`TextInputMode`	סוג הקלט שמותר בשדה להזנת קלט זה, משתמשים ב-RICH_TEXT כדי לתמוך בהוספת משתנים.

חזרה

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

חזרה

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

`setVisibility(visibility)`

ההגדרה הזו קובעת את רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.

פרמטרים

שם	סוג	תיאור
`visibility`	`Visibility`	ה`Visibility` של הווידג'ט.

חזרה

‫Widget – האובייקט, לשרשור.

Class TextInput קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

addEventAction(eventAction)

פרמטרים

חזרה

setFieldName(fieldName)

פרמטרים

חזרה

setHint(hint)

פרמטרים

חזרה

setHostAppDataSource(hostAppDataSource)

פרמטרים

חזרה

setId(id)

פרמטרים

חזרה

setInputMode(inputMode)

פרמטרים

חזרה

setMultiline(multiline)

פרמטרים

חזרה

setOnChangeAction(action)

פרמטרים

חזרה

setSuggestions(suggestions)

פרמטרים

חזרה

setSuggestionsAction(suggestionsAction)

פרמטרים

חזרה

setTitle(title)

פרמטרים

חזרה

setValidation(validation)

פרמטרים

חזרה

setValue(value)

פרמטרים

חזרה

setVisibility(visibility)

פרמטרים

חזרה

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`