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

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

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

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

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

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

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

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

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

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

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

सुझाव कार्रवाइयां

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

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() ट्रिगर हो जाता है जब टेक्स्ट इनपुट फ़ोकस खो देता है.