מחלקה: בונה

gapi.cloudsearch.widget.resultscontainer.Builder

class   static

כלי ליצירת מאגרי תוצאות. שימוש ב-builder בלי להתקשר ישירות את constructor של הקונטיינרים.

יצרן

בנאי

חדשה Builder()

דוגמה

// Builds a results container.
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 resultscontainer =
      new gapi.cloudsearch.widget.resultscontainer.Builder()
        .setSearchResultsContainerElement(document.getElementById('search_result'))
        .build();

  const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById('input'))
    .setAnchor(document.getElementById('input').parentElement)
    .setResultsContainer(resultscontainer);
    .build();
}
gapi.load('client:cloudsearch-widget', onload);

שיטות

לבנות גרסת build

build() מחזירה ResultsContainer

יצירת מאגר התוצאות.

החזרות

non-null ResultsContainer 

setAdapter

setAdapter(מתאם) מחזיר Builder

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

פרמטר
מתאם	ResultsContainerAdapter הערך לא יכול להיות null.

החזרות

non-null Builder

setFacetResultsContainerElement

setFacet ResultsContainerElement(facetResultsContainerElement) מחזירה Builder

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

פרמטר
facetResultsContainerElement	רכיב הערך לא יכול להיות null.

החזרות

non-null Builder

setIncludePagination

setIncludePagination(includePagination) מחזיר את ה-Builder

אופציונלי. ברירת המחדל היא True. כולל ממשק משתמש של עימוד שמוגדר כברירת מחדל במאגר התוצאות, אם הוא מוגדר כ-True.

פרמטר
includePagination	בוליאני

החזרות

non-null Builder

setResultsContainer

set ResultsContainer(resultsContainer) מחזירה Builder

נדרש. מגדיר את הרכיב של הקונטיינר. חייב להיות רכיב חוקי שיכול להכיל צומתי צאצא.

פרמטר
resultsContainer	רכיב הערך לא יכול להיות null.

הוצא משימוש

החזרות

non-null Builder

setSearchApplicationId

setSearchApplicationId(searchApplicationId) מחזיר Builder

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

פרמטר
searchApplicationId	מחרוזת

החזרות

non-null Builder

setSearchResultsContainerElement

setSearchתוצאותContainerElement(searchresultsContainerElement) מחזירה Builder

נדרש. מגדיר את הרכיב של הקונטיינר. חייב להיות רכיב חוקי שיכול להכיל צומתי צאצא.

פרמטר
searchResultsContainerElement	רכיב הערך לא יכול להיות null.

החזרות

non-null Builder