מחלקה: בונה

gapi.cloudsearch.widget.resultscontainer.Builder

class   סטטי

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

יצרן

בנאי/ת

חדש 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(adapter) returns Builder

Optional. מגדיר את המתאם להתאמה אישית של חוויית המשתמש.

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

החזרות

non-null Builder הזו

setFacetResultsContainerElement

setFacetResultsContainerElement(facetResultsContainerElement) החזרות Builder

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

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

החזרות

non-null Builder הזו

setIncludePagination

setIncludePagination(includePagination) returns Builder

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

פרמטר
includePagination	boolean

החזרות

non-null Builder הזו

setResultsContainer

setResultsContainer(resultsContainer) Builder)

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

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

הוצא משימוש

החזרות

non-null Builder הזו

setSearchApplicationId

setSearchApplicationId(searchApplicationId) returns Builder

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

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

החזרות

non-null Builder הזו

setSearchResultsContainerElement

setSearchResultsContainerElement(searchResultsContainerElement) החזרות Builder

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

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

החזרות

non-null Builder הזו