Klasse: Builder

Konstruktor

Builder

neu Builder()

Beispiel

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

Methoden

Build

build() returns SearchBox

Gibt Folgendes zurück:

non-null SearchBox 

setAdapter

setAdapter(adapter) gibt Builder zurück

Erforderlich. Passen Sie die Suche des Nutzers mit diesem Adapter an.

Parameter

Netzteil

SearchBoxAdapter

Sie können einen Teil der Methoden überschreiben.

Der Wert darf nicht null sein.

Gibt Folgendes zurück:

non-null Builder dieses

Beispiel

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) gibt Builder zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Elemente enthalten kann Knoten. Anker des Such-Overlays. Das Overlay wird hinzugefügt, als letztes untergeordnetes Element in "Anchor" ein. Die Position des Overlays von Anker unten.

Parameter

anchor

HTMLElement

Der Wert darf nicht null sein.

Verworfen
Stattdessen „setAnchorElement“ verwenden
Gibt Folgendes zurück:

non-null Builder dieses

setAnchorElement

setAnchorElement(anchorElement) gibt Builder zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Elemente enthalten kann Knoten. Anker des Such-Overlays. Das Overlay wird hinzugefügt, als letztes untergeordnetes Element in "Anchor" ein. Die Position des Overlays von Anker unten.

Parameter

anchorElement

HTMLElement

Der Wert darf nicht null sein.

Gibt Folgendes zurück:

non-null Builder dieses

setHints

setHints(hints) gibt Builder zurück

Optional: Die Hinweise im Suchfeld, wenn die Eingabe leer ist. Wenn die Eingabe leer ist, wird ein zufälliger Hinweis aus dem Array ausgewählt.

Parameter

Hinweise

String-Array

Der Wert darf nicht null sein.

Gibt Folgendes zurück:

non-null Builder dieses

setInput

setInput(input) gibt Builder zurück

Erforderlich. Ein HTMLElement, in das der Nutzer die Anfrage eingibt. Muss <input> sein oder <textarea>

Parameter

Eingabe

HTMLElement

Der Wert darf nicht null sein.

Verworfen
Stattdessen „setInputElement“ verwenden
Gibt Folgendes zurück:

non-null Builder dieses

setInputElement

setInputElement(inputElement) returns Builder

Erforderlich. Ein HTMLElement, in das der Nutzer die Anfrage eingibt. Muss <input> sein oder <textarea>

Parameter

inputElement

HTMLElement

Der Wert darf nicht null sein.

Gibt Folgendes zurück:

non-null Builder dieses

setResultsContainer

setResultsContainer(resultsContainer) gibt Builder zurück

Optional: Container zum Anzeigen von Suchergebnissen. Wenn dieser Wert festgelegt ist, werden die Ergebnisse im Suchergebniscontainer gerendert. Wenn die Richtlinie nicht konfiguriert ist, werden die Ergebnisse auf cloudsearch.google.com angezeigt.

Parameter

resultsContainer

gapi.cloudsearch.widget.resultscontainer.ResultsContainer

Der Wert darf nicht null sein.

Weitere Informationen
ResultsContainer
Gibt Folgendes zurück:

non-null Builder dieses

setSearchApplicationId

setSearchApplicationId(searchApplicationId) gibt Builder zurück

Optional: Legt die Suchanwendungs-ID fest, die für Anfragen verwendet werden soll. Muss das Präfix „searchapplications/“ haben.

Parameter

searchApplicationId

String

Gibt Folgendes zurück:

non-null Builder dieses

setThrottleInterval

setThrottleInterval(throttleInterval) gibt Builder zurück

Optional: Das Drosselungsintervall in ms beim Auslösen der Anfrage. Das Suchfeld sendet pro „throttleInterval“ weniger als eine Anfrage. Millisekunden. Wenn „throttleInternal“ kleiner als 200 ist, ignoriert das Suchfeld den Wert und verwendet stattdessen 200 als Intervall.

Parameter

throttleInterval

Zahl

Gibt Folgendes zurück:

non-null Builder dieses