algoliasearch client android
3.27.0
Nosso cliente API Android é legado e está apenas em modo de manutenção. Recomendamos usar nosso cliente API Kotlin, que é mais adequado para desenvolvimento Android.
Algolia Search é um mecanismo de busca hospedado capaz de fornecer resultados em tempo real desde o primeiro toque de tecla.
O Algolia Search API Client para Android permite que você use facilmente a API REST Algolia Search a partir do seu código Android.
Observação: se você estava usando a versão 2.x do nosso cliente Android, leia o guia de migração para a versão 3.x.
Você pode navegar pela documentação de referência gerada automaticamente.
Este projeto é de código aberto sob a licença MIT.
Suas contribuições são bem-vindas! Use nossa configuração de formatação para manter o estilo de codificação consistente.
Você pode encontrar a referência completa no site da Algolia.
Contribuindo
Instalar
Início rápido
Enviar dados
Configurar
Procurar
Lista de métodos disponíveis
Obtendo ajuda
Lista de métodos disponíveis
Instale o cliente Android adicionando a seguinte dependência ao arquivo de compilação Gradle :
dependencies {
// [...]
implementation ' com.algolia:algoliasearch-android:3.+ '
// This will automatically update to the latest v3 release when you build your project
}Em 30 segundos, este tutorial de início rápido mostrará como indexar e pesquisar objetos.
Para começar, você precisa inicializar o cliente. Para fazer isso, você precisa do ID do aplicativo e da chave de API . Você pode encontrar ambos em sua conta Algolia.
Client client = new Client ( "YourApplicationID" , "YourAPIKey" );
Index index = client . getIndex ( "your_index_name" );Aviso: se você estiver criando um aplicativo nativo para dispositivos móveis, certifique-se de não incluir a chave da API de pesquisa diretamente no código-fonte . Em vez disso, você deve considerar buscar a chave em seus servidores durante a inicialização do aplicativo.
Sem nenhuma configuração prévia, você pode começar a indexar contatos no índice contacts usando o seguinte código:
Index index = client . initIndex ( "contacts" );
index . addObjectAsync ( new JSONObject ()
. put ( "firstname" , "Jimmie" )
. put ( "lastname" , "Barninger" )
. put ( "followers" , 93 )
. put ( "company" , "California Paint" ), null );
index . addObjectAsync ( new JSONObject ()
. put ( "firstname" , "Warren" )
. put ( "lastname" , "Speach" )
. put ( "followers" , 42 )
. put ( "company" , "Norwalk Crmc" ), null );Você pode personalizar as configurações para ajustar o comportamento da pesquisa. Por exemplo, você pode adicionar uma classificação personalizada por número de seguidores para aumentar ainda mais a relevância integrada:
JSONObject settings = new JSONObject (). append ( "customRanking" , "desc(followers)" );
index . setSettingsAsync ( settings , null );Você também pode configurar a lista de atributos que deseja indexar por ordem de importância (os mais importantes primeiro).
Nota: Algolia foi projetado para sugerir resultados conforme você digita, o que significa que você geralmente pesquisará por prefixo. Nesse caso, a ordem dos atributos é crucial para decidir qual acerto é o melhor.
JSONObject settings = new JSONObject ()
. put ( "searchableAttributes" , "lastname" )
. put ( "searchableAttributes" , "firstname" )
. put ( "searchableAttributes" , "company" );
index . setSettingsAsync ( settings , null ); Agora você pode pesquisar contatos por firstname , lastname , company , etc. (mesmo com erros de digitação):
CompletionHandler completionHandler = new CompletionHandler () {
@ Override
public void requestCompleted ( JSONObject content , AlgoliaException error ) {
// [...]
}
};
// Search for a first name
index . searchAsync ( new Query ( "jimmie" ), completionHandler );
// Search for a first name with typo
index . searchAsync ( new Query ( "jimie" ), completionHandler );
// Search for a company
index . searchAsync ( new Query ( "california paint" ), completionHandler );
// Search for a first name and a company
index . searchAsync ( new Query ( "jimmie paint" ), completionHandler );
