algoliasearch client android
3.27.0
يعد عميل Android API الخاص بنا قديمًا، وهو في وضع الصيانة فقط. نوصي باستخدام عميل Kotlin API الخاص بنا والذي يناسب بشكل أفضل تطوير Android.
Algolia Search هو محرك بحث مستضاف قادر على تقديم نتائج فورية من أول ضغطة على المفتاح.
يتيح لك Algolia Search API Client لنظام Android استخدام Algolia Search REST API بسهولة من كود Android الخاص بك.
ملاحظة: إذا كنت تستخدم الإصدار 2.x من عميل Android الخاص بنا، فاقرأ دليل الترحيل إلى الإصدار 3.x.
يمكنك تصفح الوثائق المرجعية التي تم إنشاؤها تلقائيا.
هذا المشروع مفتوح المصدر بموجب ترخيص MIT.
مساهماتك هي موضع ترحيب! الرجاء استخدام تكوين التنسيق الخاص بنا للحفاظ على اتساق نمط الترميز.
يمكنك العثور على المرجع الكامل على موقع Algolia الإلكتروني.
المساهمة
ثَبَّتَ
بداية سريعة
دفع البيانات
تكوين
يبحث
قائمة الطرق المتاحة
الحصول على المساعدة
قائمة الطرق المتاحة
قم بتثبيت عميل Android عن طريق إضافة التبعية التالية إلى ملف بناء Gradle الخاص بك:
dependencies {
// [...]
implementation ' com.algolia:algoliasearch-android:3.+ '
// This will automatically update to the latest v3 release when you build your project
}في 30 ثانية، سيوضح لك هذا البرنامج التعليمي للبدء السريع كيفية فهرسة الكائنات والبحث عنها.
للبدء، تحتاج إلى تهيئة العميل. للقيام بذلك، تحتاج إلى معرف التطبيق ومفتاح API . يمكنك العثور على كليهما على حساب Algolia الخاص بك.
Client client = new Client ( "YourApplicationID" , "YourAPIKey" );
Index index = client . getIndex ( "your_index_name" );تحذير: إذا كنت تقوم بإنشاء تطبيق أصلي على الهاتف المحمول، فتأكد من عدم تضمين مفتاح واجهة برمجة تطبيقات البحث مباشرة في التعليمات البرمجية المصدر . يجب عليك بدلاً من ذلك التفكير في جلب المفتاح من خوادمك أثناء بدء تشغيل التطبيق.
بدون أي تكوين مسبق، يمكنك البدء في فهرسة جهات الاتصال في فهرس contacts باستخدام الكود التالي:
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 );يمكنك تخصيص الإعدادات لضبط سلوك البحث. على سبيل المثال، يمكنك إضافة تصنيف مخصص حسب عدد المتابعين لتعزيز الصلة المضمنة بشكل أكبر:
JSONObject settings = new JSONObject (). append ( "customRanking" , "desc(followers)" );
index . setSettingsAsync ( settings , null );يمكنك أيضًا تكوين قائمة السمات التي تريد فهرستها حسب ترتيب الأهمية (الأكثر أهمية أولاً).
ملاحظة: تم تصميم Algolia لاقتراح النتائج أثناء الكتابة، مما يعني أنك ستبحث بشكل عام حسب البادئة. في هذه الحالة، يعد ترتيب السمات أمرًا بالغ الأهمية لتحديد النتيجة الأفضل.
JSONObject settings = new JSONObject ()
. put ( "searchableAttributes" , "lastname" )
. put ( "searchableAttributes" , "firstname" )
. put ( "searchableAttributes" , "company" );
index . setSettingsAsync ( settings , null ); يمكنك الآن البحث عن جهات الاتصال حسب firstname أو lastname أو company وما إلى ذلك (حتى مع الأخطاء المطبعية):
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 );
