Classe: Builder

gapi.cloudsearch.widget.searchbox.Builder

classe   estática

Criador de uma caixa de pesquisa. Usar um builder e não chamar diretamente construtor da caixa de pesquisa.

Construtor

Builder

novos 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() returns SearchBox

Retorna

non-null SearchBox 

setAdapter

setAdapter(adapter) retorna o Builder

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

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

Retorna

non-null Builder isso

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 filhos nós. Âncora da sobreposição de pesquisa. A sobreposição é adicionada como o último filho na âncora. A posição da sobreposição é o parte inferior da âncora.

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

Suspenso

Usar "setAnchorElement" em vez disso

Retorna

non-null Builder isso

setAnchorElement

setAnchorElement(anchorElement) retorna Builder.

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

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

Retorna

non-null Builder isso

setHints

setHints(hints) retorna o Builder

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

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

Retorna

non-null Builder isso

setInput

setInput(input) retorna o Builder

Obrigatório. Um HTMLElement usado pelo usuário para inserir a consulta. Precisa ser <input> ou <textarea>

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

Suspenso

Usar "setInputElement"

Retorna

non-null Builder isso

setInputElement

setInputElement(inputElement) returns Builder

Obrigatório. Um HTMLElement usado pelo usuário para inserir a consulta. Precisa ser <input> ou <textarea>

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

Retorna

non-null Builder isso

setResultsContainer

setResultsContainer(resultsContainer) retorna o construtor

Opcional. Contêiner para exibição dos resultados da pesquisa. Se definido, os resultados são renderizados no contêiner de resultados da pesquisa. Se a política não for definida, os resultados serão exibidos 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 isso

setSearchApplicationId

setSearchApplicationId(searchApplicationId) retorna Builder

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

Parâmetro
searchApplicationId	string

Retorna

non-null Builder isso

setThrottleInterval

setThrottleInterval(intervaloInterval) retorna o Builder

Opcional. O intervalo de limitação em ms na solicitação de disparo. A caixa de pesquisa envia menos de uma solicitação a cada boundInterval milésimos de segundo. Se constraintInternal é menor que 200, a caixa de pesquisa ignora o valor e usa 200 como intervalo.

Parâmetro
throttleInterval	number

Retorna

non-null Builder isso