टेक्स्ट इनपुट के लिए अपने-आप पूरे होने वाले सुझाव

टेक्स्ट इनपुट विजेट आपके ऐड-ऑन को पढ़ने की सुविधा देता है और उपयोगकर्ताओं के दिए गए टेक्स्ट पर प्रतिक्रिया देता है. उपयोगकर्ताओं को इनपुट टेक्स्ट के लिए अपने-आप सुझाव देने के लिए, इन विजेट को कॉन्फ़िगर किया जा सकता है.

दिए गए सुझाव, आपकी दी गई स्ट्रिंग की स्टैटिक सूची से मिल सकते हैं. इसके अलावा, कॉन्टेक्स्ट के हिसाब से सुझाव बनाए जा सकते हैं. जैसे, वह टेक्स्ट जिसे उपयोगकर्ता ने पहले से ही विजेट में टाइप किया है.

सुझावों को कॉन्फ़िगर करना

किसी टेक्स्ट इनपुट के लिए सुझाव कॉन्फ़िगर करने के लिए, आपको सिर्फ़ ये काम करने होंगे:

• सुझावों की सूची इस तरह बनाएं:
  • स्टैटिक सूची बनाना और/या
  • ऐसे कॉलबैक फ़ंक्शन के साथ कार्रवाई तय करना जो संदर्भ से डाइनैमिक तौर पर सूची बनाता है.
• टेक्स्ट इनपुट विजेट में, सुझावों की सूची और/या कार्रवाई अटैच करें.

अगर सुझावों और कार्रवाई, दोनों की स्टैटिक सूची दी जाती है, तो ऐप्लिकेशन यूज़र इंटरफ़ेस (यूआई), स्टैटिक सूची का इस्तेमाल तब तक करता है, जब तक उपयोगकर्ता वर्ण डालना शुरू नहीं करता. इसमें कॉलबैक फ़ंक्शन का इस्तेमाल किया जाता है और स्टैटिक सूची को अनदेखा किया जाता है.

स्टैटिक सुझाव

सुझावों की स्टैटिक सूची उपलब्ध कराने के लिए, आपको सिर्फ़ ये काम करने होंगे:

1. कोई Suggestions ऑब्जेक्ट बनाएं.
2. addSuggestion() या addSuggestions() का इस्तेमाल करके, हर स्टैटिक सुझाव को जोड़ें.
3. TextInput.setSuggestions() का इस्तेमाल करके, Suggestions ऑब्जेक्ट को विजेट में अटैच करें.

यूज़र इंटरफ़ेस (यूआई), स्टैटिक सुझावों को उसी क्रम में दिखाता है जिस क्रम में उन्हें जोड़ा गया था. यूज़र इंटरफ़ेस (यूआई), अपने-आप केस-इनसेंसिटिव प्रीफ़िक्स मैचिंग की सुविधा भी देता है. साथ ही, विजेट में उपयोगकर्ता टाइप के वर्णों के तौर पर, सुझाव वाली सूची को फ़िल्टर भी करता है.

सुझाव के लिए कार्रवाइयां

अगर स्टैटिक सुझावों की सूची का इस्तेमाल नहीं किया जा रहा है, तो डाइनैमिक तरीके से सुझाव बनाने के लिए, आपको कोई कार्रवाई तय करनी होगी. ऐसा करने के लिए, आप ये कदम उठा सकते हैं:

1. कोई Action ऑब्जेक्ट बनाएं और उसे आपके तय किए गए कॉलबैक फ़ंक्शन से जोड़ें.
2. विजेट के TextInput.setSuggestionsAction() फ़ंक्शन को कॉल करें, ताकि इसे Action ऑब्जेक्ट मिल सके.
3. सुझाव सूची बनाने और पहले से बने SuggestionsResponse ऑब्जेक्ट को पाने के लिए, कॉलबैक फ़ंक्शन लागू करें.

जब भी उपयोगकर्ता टेक्स्ट इनपुट में कोई वर्ण टाइप करता है, तब यूज़र इंटरफ़ेस (यूआई) कॉलबैक फ़ंक्शन को कॉल करता है, लेकिन ऐसा तब ही होता है, जब उपयोगकर्ता कुछ देर के लिए टाइप करना बंद कर देता है. कॉलबैक फ़ंक्शन को एक इवेंट ऑब्जेक्ट मिलता है, जिसमें खुले कार्ड के विजेट के बारे में जानकारी होती है. ज़्यादा जानकारी के लिए, ऐक्शन इवेंट से जुड़े ऑब्जेक्ट देखें.

कॉलबैक फ़ंक्शन को एक मान्य SuggestionsResponse ऑब्जेक्ट दिखाना चाहिए, जिसमें दिखाने के लिए सुझावों की सूची शामिल हो. यूज़र इंटरफ़ेस (यूआई), सुझावों को उसी क्रम में दिखाता है जिस क्रम में उन्हें जोड़ा जाता है. स्टैटिक सूचियों के उलट, यूज़र इंटरफ़ेस (यूआई) उपयोगकर्ता इनपुट के आधार पर कॉलबैक सुझावों को अपने-आप फ़िल्टर नहीं करता. अगर आपको इस तरह की फ़िल्टर करने हैं, तो आपको इवेंट ऑब्जेक्ट से टेक्स्ट इनपुट वैल्यू को पढ़ना होगा. साथ ही, सूची बनाते समय अपने सुझावों को फ़िल्टर करना होगा.

उदाहरण

यहां दिया गया Google Workspace ऐड-ऑन कोड स्निपेट, दो अलग-अलग टेक्स्ट इनपुट विजेट पर सुझाव कॉन्फ़िगर करने का तरीका बताता है. पहला, स्टैटिक सूची के साथ और दूसरा कॉलबैक फ़ंक्शन का इस्तेमाल करके:

// Create an input with a static suggestion list.
var textInput1 = CardService.newTextInput()
    .setFieldName('colorInput')
    .setTitle('Color choice')
    .setSuggestions(CardService.newSuggestions()
        .addSuggestion('Red')
        .addSuggestion('Yellow')
        .addSuggestions(['Blue', 'Black', 'Green']));

// Create an input with a dynamic suggestion list.
var action = CardService.newAction()
    .setFunctionName('refreshSuggestions');
var textInput2 = CardService.newTextInput()
    .setFieldName('emailInput')
    .setTitle('Email')
    .setSuggestionsAction(action);

// ...

/**
 *  Build and return a suggestion response. In this case, the suggestions
 *  are a list of emails taken from the To: and CC: lists of the open
 *  message in Gmail, filtered by the text that the user has already
 *  entered. This method assumes the Google Workspace
 *  add-on extends Gmail; the add-on only calls this method for cards
 *  displayed when the user has entered a message context.
 *
 *  @param {Object} e the event object containing data associated with
 *      this text input widget.
 *  @return {SuggestionsResponse}
 */
 function refreshSuggestions(e) {
   // Activate temporary Gmail scopes, in this case so that the
   // open message metadata can be read.
   var accessToken = e.gmail.accessToken;
   GmailApp.setCurrentMessageAccessToken(accessToken);

   var userInput = e && e.formInput['emailInput'].toLowerCase();
   var messageId = e.gmail.messageId;
   var message = GmailApp.getMessageById(messageId);

   // Combine the comma-separated returned by these methods.
   var addresses = message.getTo() + ',' + message.getCc();

   // Filter the address list to those containing the text the user
   // has already entered.
   var suggestionList = [];
   addresses.split(',').forEach(function(email) {
     if (email.toLowerCase().indexOf(userInput) !== -1) {
       suggestionList.push(email);
     }
   });
   suggestionList.sort();

   return CardService.newSuggestionsResponseBuilder()
       .setSuggestions(CardService.newSuggestions()
           .addSuggestions(suggestionList))
       .build();  // Don't forget to build the response!
 }

सुझाव और OnChangeAction()

टेक्स्ट इनपुट विजेट में setOnChangeAction() हैंडलर फ़ंक्शन हो सकता है, जो विजेट के फ़ोकस खो देने पर काम करता है. अगर यह हैंडलर और सुझाव, दोनों एक ही टेक्स्ट इनपुट के लिए चालू हैं, तो ये नियम टेक्स्ट इनपुट इंटरैक्शन के व्यवहार को तय करते हैं:

1. setOnChangeAction() हैंडलर, किसी सुझाव को चुनने के बाद काम करता है.
2. अगर उपयोगकर्ता, चुने गए सुझाव में बदलाव किए बिना Enter दबाता है (या टेक्स्ट इनपुट को फ़ोकस में नहीं रखता है), तो setOnChangeAction() दोबारा ट्रिगर नहीं होता.
3. अगर उपयोगकर्ता किसी सुझाव को चुनने के बाद, उसमें बदलाव करता है, ताकि वह सूची में दिए गए किसी भी सुझाव से मेल न खाए, तो setOnChangeAction() फिर से ट्रिगर होता है.
4. अगर उपयोगकर्ता कोई सुझाव नहीं चुनता है, तो टेक्स्ट इनपुट के फ़ोकस बंद होने पर, setOnChangeAction() ट्रिगर हो जाता है.