Classe: Builder

gapi.cloudsearch.widget.searchbox.Builder

class   static

Criador de uma caixa de pesquisa. Use um builder e não chame diretamente o construtor da caixa de pesquisa.

Construtor

Builder

new Builder()

Exemplo

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

Métodos

build

build() retorna SearchBox

Retorna

non-null SearchBox 

setAdapter

setAdapter(adapter) retorna Builder

Obrigatório. Personalize a experiência de pesquisa do usuário com esse adaptador.

Parâmetro
adapter	SearchBoxAdapter É possível substituir parte dos métodos. O valor não pode ser nulo.

Retorna

non-null Builder este

Exemplo

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) retorna Builder

Obrigatório. Precisa ser um HTMLElement válido que possa conter nós filhos. Âncora da sobreposição de pesquisa. A sobreposição é adicionada como o último filho na âncora. A posição da sobreposição é a parte de baixo da âncora.

Parâmetro
âncora	HTMLElement O valor não pode ser nulo.

Descontinuado

Use "setAnchorElement"

Retorna

non-null Builder este

setAnchorElement

setAnchorElement(anchorElement) retorna Builder

Obrigatório. Precisa ser um HTMLElement válido que possa conter nós filhos. Âncora da sobreposição de pesquisa. A sobreposição é adicionada como o último filho na âncora. A posição da sobreposição é a parte de baixo da âncora.

Parâmetro
anchorElement	HTMLElement O valor não pode ser nulo.

Retorna

non-null Builder este

setHints

setHints(hints) retorna Builder

Opcional. As dicas na caixa de pesquisa quando a entrada está vazia. Quando a entrada está vazia, uma dica aleatória é escolhida da matriz.

Parâmetro
dicas	Matriz de string O valor não pode ser nulo.

Retorna

non-null Builder este

setInput

setInput(input) retorna Builder

Obrigatório. Um HTMLElement em que o usuário insere a consulta. Precisa ser <input> ou <textarea>

Parâmetro
entrada	HTMLElement O valor não pode ser nulo.

Descontinuado

Use "setInputElement" em vez disso

Retorna

non-null Builder este

setInputElement

setInputElement(inputElement) retorna Builder

Obrigatório. Um HTMLElement em que o usuário insere a consulta. Precisa ser <input> ou <textarea>

Parâmetro
inputElement	HTMLElement O valor não pode ser nulo.

Retorna

non-null Builder este

setResultsContainer

setResultsContainer(resultsContainer) retorna Builder

Opcional. Contêiner para mostrar os resultados da pesquisa. Se definido, os resultados são renderizados no contêiner de resultados da pesquisa. Se não for definido, os resultados vão aparecer em cloudsearch.google.com.

Parâmetro
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer O valor não pode ser nulo.

Consulte também

ResultsContainer

Retorna

non-null Builder este

setSearchApplicationId

setSearchApplicationId(searchApplicationId) retorna Builder

Opcional. Define o ID do aplicativo de pesquisa a ser usado para solicitações. Precisa ter o prefixo "searchapplications/".

Parâmetro
searchApplicationId	string

Retorna

non-null Builder este

setThrottleInterval

setThrottleInterval(throttleInterval) retorna Builder

Opcional. O intervalo de aceleração em ms na solicitação de disparo. A caixa de pesquisa envia menos de uma solicitação a cada milissegundos de throttleInterval. Se throttleInternal for menor que 200, a caixa de pesquisa vai ignorar o valor e usar 200 como intervalo.

Parâmetro
throttleInterval	número

Retorna

non-null Builder este