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

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

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

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

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

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

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

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

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

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() ट्रिगर होता है.