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

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

عامل بناء

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) المُنشئ

مَعلمة مطلوبة. يمكنك تخصيص تجربة بحث المستخدم باستخدام هذا المحوّل.

المَعلمة

محوّل

SearchBoxAdapter

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

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

المرتجعات

non-null Builder هذه

مثال

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

builder.setAdapter(adapter).build();

setAnchor

تُرجع setAnchor(anchor) أداة الإنشاء

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

المَعلمة

علامة ارتساء

HTMLElement

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

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

non-null Builder هذه

setAnchorElement

تعرض setAnchorElement(anchorElement) أداة إنشاء

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

المَعلمة

anchorElement

HTMLElement

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

المرتجعات

non-null Builder هذه

setHints

نتائج setHints(hints)

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

المَعلمة

تلميحات

مصفوفة من السلسلة

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

المرتجعات

non-null Builder هذه

setInput

تعرض setInput(input) أداة الإنشاء

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

المَعلمة

إدخال

HTMLElement

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

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

non-null Builder هذه

setInputElement

تعرض setInputElement(inputElement) أداة الإنشاء

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

المَعلمة

inputElement

HTMLElement

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

المرتجعات

non-null Builder هذه

setResultsContainer

تعرض setResultsContainer(resultsContainer) أداة إنشاء

Optional. حاوية لعرض نتائج البحث وفي حال ضبطها، يتم عرض النتائج في حاوية نتائج البحث. وفي حال ترك هذه السياسة بدون ضبط، سيتم عرض النتائج في cloudsearch.google.com.

المَعلمة

resultsContainer

gapi.cloudsearch.widget.resultscontainer.ResultsContainer

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

يمكن أيضًا مراجعة
ResultsContainer
المرتجعات

non-null Builder هذه

setSearchApplicationId

تعرض setSearchApplicationId(searchApplicationId) أداة الإنشاء

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

المَعلمة

searchApplicationId

سلسلة

المرتجعات

non-null Builder هذه

setThrottleInterval

تعرض setThrottleInterval(throttleInterval) أداة الإنشاء

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

المَعلمة

throttleInterval

الرقم

المرتجعات

non-null Builder هذه