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

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

عامل بناء

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

SearchBoxAdapter

يمكنك إلغاء جزء من الطرق.

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

المرتجعات

non-null Builder هذا

مثال

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

builder.setAdapter(adapter).build();

setAnchor

تؤدي دالة setAnchor(anchor) إلى عرض القيمة Builder.

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

المَعلمة

علامة ارتساء

HTMLElement

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

منهي العمل به
استخدِم setAnchorElement بدلاً من ذلك
المرتجعات

non-null Builder هذا

setAnchorElement

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

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

المَعلمة

anchorElement

HTMLElement

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

المرتجعات

non-null Builder هذا

setHints

تؤدي دالة setHints(hints) إلى عرض القيمة Builder.

Optional. التلميحات في مربّع البحث عندما يكون الإدخال فارغًا عندما يكون الإدخال فارغًا، يتم اختيار تلميح عشوائي من الصفيف.

المَعلمة

تلميحات

مصفوفة سلاسل

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

المرتجعات

non-null Builder هذا

setInput

تؤدي دالة setInput(input) إلى عرض Builder

مَعلمة مطلوبة. عنصر HTMLElement يُدخل فيه المستخدم طلب البحث يجب أن يكون <input> أو <textarea>

المَعلمة

إدخال

HTMLElement

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

منهي العمل به
استخدِم setInputElement بدلاً من ذلك
المرتجعات

non-null Builder هذا

setInputElement

تُعرِض الدالة setInputElement(inputElement) العنصر Builder.

مَعلمة مطلوبة. عنصر HTMLElement يُدخل فيه المستخدم طلب البحث يجب أن يكون <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) إلى عرض Builder.

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

المَعلمة

searchApplicationId

سلسلة

المرتجعات

non-null Builder هذا

setThrottleInterval

تؤدي setThrottleInterval(throttleInterval) إلى إنشاء Builder

Optional. الفاصل الزمني للحدّ من السرعة بالكيلومتر في الساعة عند بدء الطلب. يُرسِل مربّع البحث أقل من طلب واحد كل throttleInterval مللي ثانية. إذا كانت قيمة throttleInternal أقل من 200، يتجاهل مربّع البحث القيمة ويستخدم 200 كفاصل بدلاً من ذلك.

المَعلمة

throttleInterval

الرقم

المرتجعات

non-null Builder هذا