الفئة: عامل بناء

gapi.cloudsearch.widget.resultscontainer.Builder

class   static

أداة إنشاء حاويات النتائج استخدِم أداة إنشاء ولا تستدعي مباشرةً الدالة الإنشائية للحاوية.

الشركة المصنِّعة

عامل بناء

new 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() العنصر ResultsContainer.

تُنشئ حاوية النتائج.

المرتجعات

non-null ResultsContainer 

setAdapter

تؤدي دالة setAdapter(adapter) إلى إنشاء كائن من فئة Builder

Optional. ضبط المحوِّل لتخصيص تجربة المستخدم

المَعلمة
adapter	ResultsContainerAdapter يجب ألا تكون القيمة فارغة.

المرتجعات

non-null Builder هذا

setFacetResultsContainerElement

تؤدي دالة setFacetResultsContainerElement(facetResultsContainerElement) إلى عرض العنصر Builder.

لضبط عنصر الحاوية لنتائج الواجهات يجب أن يكون عنصرًا صالحًا يمكن أن يحتوي على عقد فرعية.

المَعلمة
facetResultsContainerElement	العنصر يجب ألا تكون القيمة فارغة.

المرتجعات

non-null Builder هذا

setIncludePagination

تؤدي دالة setIncludePagination(includePagination) إلى عرض Builder

Optional. القيمة التلقائية هي صحيح. يتضمّن واجهة مستخدم تلقائية لصفحة الأرقام في حاوية النتائج، إذا تم ضبطها على true.

المَعلمة
includePagination	قيمة منطقية

المرتجعات

non-null Builder هذا

setResultsContainer

تُعرِض setResultsContainer(resultsContainer) العنصر Builder.

مَعلمة مطلوبة. تُستخدَم لضبط عنصر الحاوية. يجب أن يكون عنصرًا صالحًا يمكن أن يحتوي على عقد فرعية.

المَعلمة
resultsContainer	العنصر يجب ألا تكون القيمة فارغة.

منهي العمل به

المرتجعات

non-null Builder هذا

setSearchApplicationId

تؤدي دالة setSearchApplicationId(searchApplicationId) إلى عرض Builder.

Optional. لضبط معرّف تطبيق البحث المراد استخدامه للطلبات. يجب أن تسبق قيمة العنصر البادئة "searchapplications/‎".

المَعلمة
searchApplicationId	سلسلة

المرتجعات

non-null Builder هذا

setSearchResultsContainerElement

تؤدي دالة setSearchResultsContainerElement(searchResultsContainerElement) إلى عرض العنصر Builder.

مَعلمة مطلوبة. تُستخدَم لضبط عنصر الحاوية. يجب أن يكون عنصرًا صالحًا يمكن أن يحتوي على عقد فرعية.

المَعلمة
searchResultsContainerElement	العنصر يجب ألا تكون القيمة فارغة.

المرتجعات

non-null Builder هذا