ווידג'ט של שדה קלט שמקבל קלט טקסט.
התכונה זמינה בתוספים של Google Workspace ובאפליקציות של Google Chat.
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint');
Methods
| שיטה | סוג הערך המוחזר | תיאור קצר |
|---|---|---|
set | Text | מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש. |
set | Text | הגדרת רמז לקלט הטקסט. |
set | Text | מגדיר אם טקסט הקלט יוצג בשורה אחת או בכמה שורות. |
set | Text | הגדרת פעולה שתתבצע בכל פעם שהטקסט שמוזן משתנה. |
set | Text | הגדרת ההצעות להשלמה אוטומטית בשדה הטקסט. |
set | Text | מגדיר את פעולת הקריאה החוזרת כדי לאחזר הצעות על סמך קלט המשתמש להשלמה אוטומטית. |
set | Text | הגדרת הכותרת שתוצג מעל שדה הקלט. |
set | Text | הגדרת כלל האימות של הווידג'ט הזה. |
set | Text | מגדיר את הערך שמילא מראש בשדה הקלט. |
מסמכים מפורטים
set
מגדיר את המפתח שמזהה את קלט הטקסט הזה באובייקט האירוע שנוצר כשיש אינטראקציה בממשק המשתמש. לא גלויים למשתמש. חובה, חייב להיות ייחודי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
field | String | המפתח שמשמש לזיהוי הקלט הזה. |
חזרה
Text – האובייקט הזה, לצורך קישור.
set
הגדרת רמז לקלט הטקסט. משמש למתן הנחיות נוספות למשתמש לגבי הקלט. לדוגמה, אפשר לתאר בטיפים את הפורמט ('xxx-xxx-xxxx') של שדה מספר טלפון.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
hint | String | הטקסט של ההצעה שיוצג מתחת לשדה הקלט. הטקסט הזה תמיד גלוי. |
חזרה
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 | ערך ברירת המחדל שמופיע בקלט. הוא תמיד מיוצג כמחרוזת בפרמטרים של קריאה חוזרת (callback) של הטופס. |
חזרה
Text – האובייקט הזה, לצורך קישור.