Sınıf: İnşaatçı

gapi.cloudsearch.widget.searchbox.Builder

class   static

Arama kutusu oluşturucu. Bir oluşturucu kullanın ve arama kutusu oluşturucusunu doğrudan çağırmayın.

Marka

Derleyici

new Builder()

Örnek

// 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);

Yöntemler

build

build(), SearchBox döndürür

İadeler

non-null SearchBox 

setAdapter

setAdapter(adapter) Builder döndürür

Zorunludur. Bu bağdaştırıcıyla kullanıcının arama deneyimini özelleştirin.

Parametre
adapter	SearchBoxAdapter Yöntemlerin bir kısmını geçersiz kılabilirsiniz. Değer boş olamaz.

İadeler

non-null Builder bu

Örnek

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) işlevi, Oluşturucu döndürür.

Zorunludur. Alt düğüm içerebilen geçerli bir HTMLElement olmalıdır. Arama yer paylaşımının ankrajı. Yer paylaşımı, sabit öğenin son alt öğesi olarak eklenir. Yer paylaşımının konumu, sabit reklamın alt tarafıdır.

Parametre
anchor	HTMLElement Değer boş olamaz.

Kullanımdan kaldırıldı

Bunun yerine "setAnchorElement"i kullanın

İadeler

non-null Builder bu

setAnchorElement

setAnchorElement(anchorElement) işlevi, Builder döndürür

Zorunludur. Alt düğüm içerebilen geçerli bir HTMLElement olmalıdır. Arama yer paylaşımının ankrajı. Yer paylaşımı, sabit öğenin son alt öğesi olarak eklenir. Yer paylaşımının konumu, sabit reklamın alt tarafıdır.

Parametre
anchorElement	HTMLElement Değer boş olamaz.

İadeler

non-null Builder bu

setHints

setHints(ipuçları) işlevi, Oluşturucu döndürür.

İsteğe bağlı. Giriş boşken arama kutusunda gösterilen ipuçları. Giriş boş olduğunda, diziden rastgele bir ipucu seçilir.

Parametre
ipuçları	Dize dizisi Değer boş olamaz.

İadeler

non-null Builder bu

setInput

setInput(input) işlevi, Builder döndürür

Zorunludur. Kullanıcının sorguyu girdiği bir HTMLElement. <input> veya <textarea> olmalıdır.

Parametre
giriş	HTMLElement Değer boş olamaz.

Kullanımdan kaldırıldı

Bunun yerine "setInputElement"i kullanın

İadeler

non-null Builder bu

setInputElement

setInputElement(inputElement) Builder döndürür

Zorunludur. Kullanıcının sorguyu girdiği bir HTMLElement. <input> veya <textarea> olmalıdır.

Parametre
inputElement	HTMLElement Değer boş olamaz.

İadeler

non-null Builder bu

setResultsContainer

setResultsContainer(resultsContainer), Builder döndürür

İsteğe bağlı. Arama sonuçlarını görüntülemek için kapsayıcı. Ayarlanırsa sonuçlar arama sonuçları kapsayıcısında oluşturulur. Ayarlanmamışsa sonuçlar cloudsearch.google.com adresinde gösterilir.

Parametre
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer Değer boş olamaz.

Aşağıdaki kaynakları da incelemenizi öneririz:

ResultsContainer

İadeler

non-null Builder bu

setSearchApplicationId

setSearchApplicationId(searchApplicationId) Builder döndürür

İsteğe bağlı. İstekler için kullanılacak arama uygulaması kimliğini ayarlar. "searchapplications/" ön ekini almalıdır.

Parametre
searchApplicationId	dize

İadeler

non-null Builder bu

setThrottleInterval

setThrottleInterval(throttleInterval) işlevi, Builder döndürür

İsteğe bağlı. Tetikleme isteğinde milisaniye cinsinden açma/kapatma aralığı. Arama kutusu, throttleInterval milisaniyede birten az istek gönderir. throttleInternal 200'den azsa arama kutusu bu değeri yoksayar ve bunun yerine aralığı 200 olarak kullanır.

Parametre
throttleInterval	sayı

İadeler

non-null Builder bu