टेक्स्ट इनपुट विजेट की मदद से, आपका ऐड-ऑन उपयोगकर्ताओं के दिए गए टेक्स्ट को पढ़ सकता है और उस पर कार्रवाई कर सकता है. इन विजेट को कॉन्फ़िगर करके, उपयोगकर्ताओं को इनपुट टेक्स्ट के लिए अपने-आप सुझाव दिए जा सकते हैं.
दिए गए सुझाव, आपके दिए गए स्ट्रिंग की स्टैटिक सूची से मिल सकते हैं. इसके अलावा, कॉन्टेक्स्ट के हिसाब से सुझाव भी दिए जा सकते हैं. जैसे, उपयोगकर्ता ने विजेट में जो टेक्स्ट पहले से टाइप किया है.
सुझावों को कॉन्फ़िगर करना
टेक्स्ट इनपुट के लिए सुझाव कॉन्फ़िगर करने के लिए, आपको सिर्फ़ ये काम करने होंगे:
- सुझावों की सूची बनाने के लिए:
- स्टैटिक सूची बनाना, और/या
- कॉलबैक फ़ंक्शन की मदद से ऐक्शन तय करना, जो कॉन्टेक्स्ट से डाइनैमिक तौर पर सूची बनाता है.
- सुझावों की सूची और/या कार्रवाई को टेक्स्ट इनपुट विजेट से अटैच करें.
अगर सुझावों की स्टैटिक सूची और कार्रवाई, दोनों दी जाती है, तो ऐप्लिकेशन यूज़र इंटरफ़ेस (यूआई) तब तक स्टैटिक सूची का इस्तेमाल करता है, जब तक उपयोगकर्ता वर्ण डालना शुरू नहीं कर देता. इसके बाद, कॉलबैक फ़ंक्शन का इस्तेमाल किया जाता है और स्टैटिक सूची को अनदेखा कर दिया जाता है.
स्टैटिक सुझाव
सुझावों की स्टैटिक सूची देने के लिए, आपको सिर्फ़ ये काम करने होंगे:
Suggestionsऑब्जेक्ट बनाएं.addSuggestion()याaddSuggestions()का इस्तेमाल करके, हर स्टैटिक सुझाव जोड़ें.TextInput.setSuggestions()का इस्तेमाल करके,Suggestionsऑब्जेक्ट को विजेट से अटैच करें.
यूज़र इंटरफ़ेस (यूआई), स्टैटिक सुझावों को उसी क्रम में दिखाता है जिस क्रम में उन्हें जोड़ा गया था. यूज़र इंटरफ़ेस (यूआई) में, केस-इनसेंसिटिव प्रीफ़िक्स मैचिंग की सुविधा भी अपने-आप काम करती है. साथ ही, उपयोगकर्ता के विजेट में वर्ण टाइप करने पर, सुझावों की सूची को फ़िल्टर करती है.
सुझाव वाली कार्रवाइयां
अगर सुझावों की स्टैटिक सूची का इस्तेमाल नहीं किया जा रहा है, तो आपको सुझावों को डाइनैमिक तौर पर बनाने के लिए कोई कार्रवाई तय करनी होगी. ऐसा करने के लिए, आप ये कदम उठा सकते हैं:
Actionऑब्जेक्ट बनाएं और उसे अपने तय किए गए कॉलबैक फ़ंक्शन से जोड़ें.- विजेट के
TextInput.setSuggestionsAction()फ़ंक्शन को कॉल करें. इसके लिए, उसेActionऑब्जेक्ट दें. - सुझावों की सूची बनाने के लिए, कॉलबैक फ़ंक्शन लागू करें और बनाया गया
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
* 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() के लिए एक हैंडलर फ़ंक्शन तय किया जा सकता है. यह फ़ंक्शन तब काम करता है, जब विजेट पर फ़ोकस न हो.
अगर एक ही टेक्स्ट इनपुट के लिए, यह हैंडलर और सुझाव, दोनों चालू हैं, तो टेक्स्ट इनपुट के इंटरैक्शन के व्यवहार को ये नियम तय करते हैं:
- सुझाव चुनने के बाद,
setOnChangeAction()हैंडलर लागू होता है. - अगर उपयोगकर्ता, चुने गए सुझाव में बदलाव किए बिना Enter दबाता है (या टेक्स्ट इनपुट से फ़ोकस हटाता है), तो
setOnChangeAction()फिर से ट्रिगर नहीं होता. - अगर उपयोगकर्ता किसी सुझाव को चुनने के बाद, उसमें बदलाव करता है, ताकि वह सूची में मौजूद किसी भी सुझाव से मेल न खाए, तो
setOnChangeAction()फिर से ट्रिगर होता है. - अगर उपयोगकर्ता कोई सुझाव नहीं चुनता है, तो टेक्स्ट इनपुट से फ़ोकस हटने पर
setOnChangeAction()ट्रिगर होता है.