algoliasearch client android
3.27.0
Nuestro cliente API de Android es heredado y solo está en modo de mantenimiento. Recomendamos utilizar nuestro cliente API Kotlin, que es más adecuado para el desarrollo de Android.
Algolia Search es un motor de búsqueda alojado capaz de ofrecer resultados en tiempo real desde la primera pulsación de tecla.
El cliente API de búsqueda de Algolia para Android le permite utilizar fácilmente la API REST de búsqueda de Algolia desde su código de Android.
Nota: Si estaba utilizando la versión 2.x de nuestro cliente Android, lea la guía de migración a la versión 3.x.
Puede explorar la documentación de referencia generada automáticamente.
Este proyecto es de código abierto bajo la licencia MIT.
¡Tus contribuciones son bienvenidas! Utilice nuestra configuración de formato para mantener coherente el estilo de codificación.
Puede encontrar la referencia completa en el sitio web de Algolia.
Contribuyendo
Instalar
Inicio rápido
Enviar datos
Configurar
Buscar
Lista de métodos disponibles
Obtener ayuda
Lista de métodos disponibles
Instale el cliente de Android agregando la siguiente dependencia a su archivo de compilación Gradle :
dependencies {
// [...]
implementation ' com.algolia:algoliasearch-android:3.+ '
// This will automatically update to the latest v3 release when you build your project
}En 30 segundos, este tutorial de inicio rápido le mostrará cómo indexar y buscar objetos.
Para comenzar, necesita inicializar el cliente. Para hacer esto, necesita su ID de aplicación y clave API . Puede encontrar ambos en su cuenta de Algolia.
Client client = new Client ( "YourApplicationID" , "YourAPIKey" );
Index index = client . getIndex ( "your_index_name" );Advertencia: si está creando una aplicación nativa para dispositivos móviles, asegúrese de no incluir la clave API de búsqueda directamente en el código fuente . En su lugar, debería considerar obtener la clave de sus servidores durante el inicio de la aplicación.
Sin ninguna configuración previa, puedes comenzar a indexar contactos en el índice contacts usando el siguiente 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 );Puede personalizar la configuración para ajustar el comportamiento de búsqueda. Por ejemplo, puede agregar una clasificación personalizada por número de seguidores para mejorar aún más la relevancia incorporada:
JSONObject settings = new JSONObject (). append ( "customRanking" , "desc(followers)" );
index . setSettingsAsync ( settings , null );También puedes configurar la lista de atributos que deseas indexar por orden de importancia (los más importantes primero).
Nota: Algolia está diseñada para sugerir resultados a medida que escribe, lo que significa que generalmente buscará por prefijo. En este caso, el orden de los atributos es crucial para decidir qué golpe es el mejor.
JSONObject settings = new JSONObject ()
. put ( "searchableAttributes" , "lastname" )
. put ( "searchableAttributes" , "firstname" )
. put ( "searchableAttributes" , "company" );
index . setSettingsAsync ( settings , null ); Ahora puedes buscar contactos por firstname , lastname , company , etc. (incluso con errores tipográficos):
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 );
