ווידג'ט של שדה קלט שמקבל קלט טקסט.
יש תמיכה באימות של שליחת טפסים. אם 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
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | Widget | הוספה של פעולת האירוע שאפשר לבצע בווידג'ט. |
set | Text | מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשמתבצעת אינטראקציה עם ממשק המשתמש. |
set | Text | הגדרת רמז לקלט הטקסט. |
set | Text | הגדרת מקור נתונים מאפליקציות של Google Workspace. |
set | Widget | מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות. |
set | Text | קובע אם שדה הטקסט הזה תומך בהוספת משתנים. |
set | Text | קובע אם טקסט הקלט מוצג בשורה אחת או בכמה שורות. |
set | Text | הגדרה של פעולה שתתבצע בכל פעם שמשנים את קלט הטקסט. |
set | Text | מגדיר את ההצעות להשלמה אוטומטית בשדה הטקסט. |
set | Text | מגדיר את פעולת הקריאה החוזרת לאחזור הצעות על סמך קלט המשתמש להשלמה אוטומטית. |
set | Text | מגדיר את הכותרת שתוצג מעל שדה הקלט. |
set | Text | הגדרת כלל האימות של הווידג'ט הזה. |
set | Text | מגדיר את הערך שיוזן מראש בשדה הקלט. |
set | Widget | הגדרה של רמת החשיפה של הווידג'ט. |
תיעוד מפורט
add
הוספה של פעולת האירוע שאפשר לבצע בווידג'ט.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
event | Event | ה-Event שרוצים להוסיף. |
חזרה
Widget – האובייקט, לשרשור.
set
מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשמתבצעת אינטראקציה עם ממשק המשתמש. לא מוצג למשתמש. חובה, חייב להיות ייחודי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
field | String | המפתח שמשמש לזיהוי הקלט הזה. |
חזרה
Text – האובייקט הזה, לשרשור.
set
הגדרת רמז לקלט הטקסט. התג הזה משמש כדי לספק למשתמש הנחיות נוספות לגבי הקלט שהוא צריך להזין. לדוגמה, רמז יכול לתאר את הפורמט ("xxx-xxx-xxxx") של שדה מספר טלפון.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
hint | String | הטקסט שיוצג כרמז מתחת לשדה הקלט. הטקסט הזה תמיד גלוי. |
חזרה
Text – האובייקט הזה, לשרשור.
set
הגדרת מקור נתונים מאפליקציות של 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);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
host | Host | מקור הנתונים. |
חזרה
Text – האובייקט הזה, לשרשור.
set
מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות. שינוי של ווידג'ט נתמך רק בתוספים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
id | String | המזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט `[a-zA-Z0-9-]+`. |
חזרה
Widget – האובייקט הזה, לשרשור.
set
קובע אם שדה הטקסט הזה תומך בהוספת משתנים.
האפשרות הזו זמינה רק לתוספים ל-Google Workspace שמרחיבים את Google Workspace Studio.
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setInputMode(CardService.TextInputMode.PLAIN_TEXT);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
input | Text | סוג הקלט שמותר בשדה הזה להזנת טקסט. משתמשים ב-RICH_TEXT כדי לתמוך בהוספת משתנים. |
חזרה
Text – האובייקט הזה, לשרשור.
set
קובע אם טקסט הקלט מוצג בשורה אחת או בכמה שורות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
multiline | Boolean | ההגדרה של שורות מרובות. |
חזרה
Text – האובייקט הזה, לשרשור.
set
set
מגדיר את ההצעות להשלמה אוטומטית בשדה הטקסט.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
suggestions | Suggestions | אוסף ההצעות לשימוש. |
חזרה
Text – האובייקט הזה, לשרשור.
set
מגדיר את פעולת הקריאה החוזרת לאחזור הצעות על סמך קלט המשתמש להשלמה אוטומטית. הפרמטר
Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט Suggestions.
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(); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
suggestions | Action | הפעולה שמביאה הצעות לקלט הזה. |
חזרה
Text – האובייקט הזה, לשרשור.
set
מגדיר את הכותרת שתוצג מעל שדה הקלט. חובה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
title | String | תווית הטקסט של הקלט הזה. |
חזרה
Text – האובייקט הזה, לשרשור.
set
הגדרת כלל האימות של הווידג'ט הזה.
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 | כלל האימות של הווידג'ט Text הזה. |
חזרה
Text – האובייקט הזה, לשרשור.
set
מגדיר את הערך שיוזן מראש בשדה הקלט.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
value | String | ערך ברירת המחדל שמוצב בקלט. הוא תמיד מיוצג כמחרוזת בפרמטרים של הקריאה החוזרת של הטופס. |
חזרה
Text – האובייקט הזה, לשרשור.
set
הגדרה של רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
visibility | Visibility | הVisibility של הווידג'ט. |
חזרה
Widget – האובייקט, לשרשור.