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

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

عامل بناء

جديدتان 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() returns 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(ارتساء) أداة الإنشاء

مَعلمة مطلوبة. يجب أن يكون عنصر 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) returns Builder

مَعلمة مطلوبة. يشير ذلك المصطلح إلى عنصر 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 هذه