algoliasearch client android
3.27.0
ไคลเอนต์ Android API ของเราเป็นแบบเดิมและอยู่ในโหมดบำรุงรักษาเท่านั้น เราขอแนะนำให้ใช้ไคลเอ็นต์ Kotlin API ซึ่งเหมาะสำหรับการพัฒนา Android มากกว่า
Algolia Search เป็นเสิร์ชเอ็นจิ้นที่โฮสต์ซึ่งสามารถให้ผลลัพธ์แบบเรียลไทม์ตั้งแต่การกดแป้นพิมพ์ครั้งแรก
ไคลเอนต์ Algolia Search API สำหรับ Android ช่วยให้คุณใช้ Algolia Search REST API จากโค้ด Android ของคุณได้อย่างง่ายดาย
หมายเหตุ: หากคุณใช้ไคลเอ็นต์ Android เวอร์ชัน 2.x โปรดอ่านคู่มือการย้ายข้อมูลเป็นเวอร์ชัน 3.x
คุณสามารถเรียกดูเอกสารอ้างอิงที่สร้างขึ้นโดยอัตโนมัติ
โครงการนี้เป็นโอเพ่นซอร์สภายใต้ใบอนุญาต MIT
ยินดีต้อนรับการมีส่วนร่วมของคุณ! โปรดใช้การกำหนดค่าการจัดรูปแบบของเราเพื่อให้รูปแบบการเขียนโค้ดสอดคล้องกัน
คุณสามารถดูข้อมูลอ้างอิงฉบับเต็มได้จากเว็บไซต์ของ Algolia
มีส่วนร่วม
ติดตั้ง
เริ่มต้นอย่างรวดเร็ว
พุชข้อมูล
กำหนดค่า
ค้นหา
รายการวิธีการที่มีอยู่
การขอความช่วยเหลือ
รายการวิธีการที่มีอยู่
ติดตั้งไคลเอนต์ Android โดยเพิ่มการพึ่งพาต่อไปนี้ให้กับไฟล์ Gradle build ของคุณ:
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" );คำเตือน: หากคุณกำลังสร้างแอปแบบเนทีฟบนมือถือ ตรวจสอบให้แน่ใจ ว่าไม่ได้รวมคีย์ API การค้นหาในซอร์สโค้ดโดยตรง คุณควรพิจารณาดึงคีย์จากเซิร์ฟเวอร์ของคุณระหว่างที่แอปเริ่มต้นแทน
หากไม่มีการกำหนดค่าใดๆ ก่อนหน้า คุณสามารถเริ่มสร้างดัชนีผู้ติดต่อในดัชนี 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 );
