בנאי

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

הפונקציה build() מחזירה SearchBox

החזרות

non-null SearchBox 

setAdapter

הפונקציה setAdapter(adapter) מחזירה Builder

נדרש. המתאם הזה מאפשר להתאים אישית את חוויית החיפוש של המשתמשים.

החזרות

non-null Builder זה

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

הפונקציה setAnchor(anchor) מחזירה Builder

נדרש. חייב להיות HTMLElement תקין שיכול להכיל צמתים צאצאים. עוגן של שכבת-העל של החיפוש. שכבת-העל מתווספת בתור הצאצא האחרון ב-anchor. מיקום שכבת-העל הוא בתחתית העוגן.

הוצא משימוש

שימוש ב-setAnchorElement במקום זאת

החזרות

non-null Builder זה

setAnchorElement

הפונקציה setAnchorElement(anchorElement) מחזירה Builder

נדרש. חייב להיות HTMLElement תקין שיכול להכיל צמתים צאצאים. עוגן של שכבת-העל של החיפוש. שכבת-העל מתווספת בתור הצאצא האחרון ב-anchor. מיקום שכבת-העל הוא בתחתית העוגן.

החזרות

non-null Builder זה

setHints

הפונקציה setHints(hints) מחזירה Builder

אופציונלי. הטיפים בתיבת החיפוש כשהקלט ריק. כשהקלט ריק, המערכת בוחרת רמז אקראי מהמערך.

החזרות

non-null Builder זה

setInput

הפונקציה setInput(input) מחזירה Builder

נדרש. HTMLElement שבו המשתמש מזין את השאילתה. חייב להיות <input> או <textarea>

הוצא משימוש

שימוש ב-setInputElement במקום זאת

החזרות

non-null Builder זה

setInputElement

הפונקציה setInputElement(inputElement) מחזירה Builder

נדרש. HTMLElement שבו המשתמש מזין את השאילתה. חייב להיות <input> או <textarea>

החזרות

non-null Builder זה

setResultsContainer

הפונקציה setResultsContainer(resultsContainer) מחזירה Builder

אופציונלי. מאגר להצגת תוצאות חיפוש. אם ההגדרה מוגדרת, התוצאות ייראו בקונטיינר של תוצאות החיפוש. אם לא תגדירו את ההגדרה הזו, התוצאות יוצגו בכתובת cloudsearch.google.com.

ראה גם

ResultsContainer

החזרות

non-null Builder זה

setSearchApplicationId

הפונקציה setSearchApplicationId(searchApplicationId) מחזירה Builder

אופציונלי. מגדיר את מזהה אפליקציית החיפוש שישמש לבקשות. התחילית של השם צריכה להיות 'searchapplications/‎'.

החזרות

non-null Builder זה

setThrottleInterval

הפונקציה setThrottleInterval(throttleInterval) מחזירה Builder

אופציונלי. מרווח הזמן של המצערת באלפיניות השנייה בזמן שליחת הבקשה. תיבת החיפוש שולחת פחות מבקשה אחת בכל אלפיות השנייה של throttleInterval. אם הערך של throttleInternal קטן מ-200, תיבת החיפוש תתעלם מהערך ותשתמש ב-200 בתור מרווח הזמן במקום זאת.

החזרות

non-null Builder זה