gapi.cloudsearch.widget.searchbox.Builder
खोज बॉक्स का बिल्डर. बिल्डर का इस्तेमाल करें और सीधे तौर पर खोज बॉक्स कंस्ट्रक्टर को कॉल न करें.
निर्माता
निर्माता
new Builder()
उदाहरण
// Builds a search box.
function onload() {
gapi.client.init({
'apiKey': '<your api key>',
'clientId': '<your client id>',
// Add additional scopes if needed
'scope': 'https://www.googleapis.com/auth/cloud_search.query',
'hosted_domain': '<your G Suite domain>',
});
const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
.setInput(document.getElementById('input'))
.setAnchor(document.getElementById('input').parentElement)
.build();
}
gapi.load('client:cloudsearch-widget', onload);तरीके
बिल्ड
build() से SearchBox मिलता है
- रिटर्न
-
non-null SearchBox
setAdapter
setAdapter(adapter) से Builder मिलता है
ज़रूरी है. इस अडैप्टर की मदद से, उपयोगकर्ता के लिए खोज के अनुभव को पसंद के मुताबिक बनाएं.
पैरामीटर |
|
|---|---|
|
adapter |
आपके पास कुछ तरीकों को बदलने का विकल्प होता है. वैल्यू शून्य नहीं होनी चाहिए. |
- रिटर्न
-
non-null Builderयह
उदाहरण
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();setAnchor
setAnchor(anchor) से, बिल्डर मिलता है
ज़रूरी है. यह मान्य HTMLElement होना चाहिए, जिसमें चाइल्ड node शामिल हो सकते हैं. खोज ओवरले का ऐंकर. ओवरले को ऐंकर में आखिरी चाइल्ड के तौर पर जोड़ा जाता है. ओवरले की पोज़िशन, ऐंकर के सबसे नीचे होती है.
पैरामीटर |
|
|---|---|
|
एंकर |
HTMLElement वैल्यू शून्य नहीं होनी चाहिए. |
- बहिष्कृत
- इसके बजाय, `setAnchorElement` का इस्तेमाल करें
- रिटर्न
-
non-null Builderयह
setAnchorElement
setAnchorElement(anchorElement) से बिल्डर मिलता है
ज़रूरी है. यह मान्य HTMLElement होना चाहिए, जिसमें चाइल्ड नोड शामिल हो सकते हैं. खोज ओवरले का ऐंकर. ओवरले को ऐंकर में आखिरी चाइल्ड के तौर पर जोड़ा जाता है. ओवरले की पोज़िशन, ऐंकर के सबसे नीचे होती है.
पैरामीटर |
|
|---|---|
|
anchorElement |
HTMLElement वैल्यू शून्य नहीं होनी चाहिए. |
- रिटर्न
-
non-null Builderयह
setHints
setHints(hints) से, बिल्डर मिलता है
Optional. इनपुट खाली होने पर, खोज बॉक्स पर दिखने वाले सुझाव. अगर इनपुट खाली है, तो ऐरे से कोई रैंडम हिंट चुना जाता है.
पैरामीटर |
|
|---|---|
|
सलाह |
स्ट्रिंग का कलेक्शन वैल्यू शून्य नहीं होनी चाहिए. |
- रिटर्न
-
non-null Builderयह
setInput
setInput(input) से Builder फ़ंक्शन मिलता है
ज़रूरी है. वह एचटीएमएल एलिमेंट जिसमें उपयोगकर्ता क्वेरी डालता है. यह <input> या <textarea> होना चाहिए
पैरामीटर |
|
|---|---|
|
इनपुट |
HTMLElement वैल्यू शून्य नहीं होनी चाहिए. |
- बहिष्कृत
- इसके बजाय, `setInputElement` का इस्तेमाल करें
- रिटर्न
-
non-null Builderयह
setInputElement
setInputElement(inputElement) से Builder मिलता है
ज़रूरी है. वह एचटीएमएल एलिमेंट जिसमें उपयोगकर्ता क्वेरी डालता है. यह <input> या <textarea> होना चाहिए
पैरामीटर |
|
|---|---|
|
inputElement |
HTMLElement वैल्यू शून्य नहीं होनी चाहिए. |
- रिटर्न
-
non-null Builderयह
setResultsContainer
setResultsContainer(resultsContainer) से Builder मिलता है
Optional. खोज के नतीजे दिखाने के लिए कंटेनर. अगर यह सेट है, तो नतीजे खोज के नतीजों के कंटेनर में रेंडर किए जाते हैं. अगर यह सेट नहीं है, तो नतीजे cloudsearch.google.com पर दिखाए जाते हैं.
पैरामीटर |
|
|---|---|
|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer वैल्यू शून्य नहीं होनी चाहिए. |
- इन्हें भी देखें
- ResultsContainer
- रिटर्न
-
non-null Builderयह
setSearchApplicationId
setSearchApplicationId(searchApplicationId) से बिल्डर मिलता है
Optional. अनुरोधों के लिए इस्तेमाल करने के लिए, सर्च ऐप्लिकेशन आईडी सेट करता है. इसकी शुरुआत 'searchapplications/' से होनी चाहिए.
पैरामीटर |
|
|---|---|
|
searchApplicationId |
स्ट्रिंग |
- रिटर्न
-
non-null Builderयह
setThrottleInterval
setThrottleInterval(throttleInterval) से, बिल्डर मिलता है
Optional. अनुरोध करने पर, थ्रॉटल इंटरवल को मिलीसेकंड में दिखाता है. खोज बॉक्स हर throttleInterval मिलीसेकंड में एक से कम अनुरोध भेजता है. अगर throttleInternal 200 से कम है, तो खोज बॉक्स इस वैल्यू को अनदेखा करता है और इंटरवल के तौर पर 200 का इस्तेमाल करता है.
पैरामीटर |
|
|---|---|
|
throttleInterval |
संख्या |
- रिटर्न
-
non-null Builderयह