Class TextInput

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

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
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 — यह ऑब्जेक्ट, चेनिंग के लिए होता है.