Android SDK API

คลาสยูทิลิตี้สนับสนุนภายนอก

เมธอด

getClient(Context)

ดึงวัตถุคลาสยูทิลิตี้ GTCaptcha4Client

การประกาศ

public static GTCaptcha4Client getClient(Context context)

              
              public static GTCaptcha4Client getClient(Context context)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
context	context	Context

การอภิปราย

หมายเหตุ: นี่ไม่ใช่การใช้งานแบบ singleton วัตถุ GTCaptcha4Client ที่ได้รับผ่าน getClient() จำเป็นต้องบันทึกเพื่อใช้งานใน onDestroy หรือเมธอด lifecycle อื่นๆ

init(String)

เริ่มต้นด้วยการกำหนดค่าเริ่มต้น

การประกาศ

public GTCaptcha4Client init(String captchaId)

              
              public GTCaptcha4Client init(String captchaId)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
captchaId	String	Captcha ID ที่ได้รับจาก backend

การอภิปราย

หมายเหตุ: หลังจากเรียกใช้เมธอด init() การโหลด captcha จะถูกดำเนินการ หากเรียกก่อน lifecycle onResume() captcha จะถูกโหลดล่วงหน้า เมื่อ verifyWithCaptcha() ถูกเรียกเพื่อแสดง captcha จะโหลดและแสดงได้อย่างรวดเร็ว เช่นเดียวกันกับด้านล่าง

init(String, GTCaptcha4Config)

เริ่มต้นด้วยการกำหนดค่าที่กำหนดเอง

การประกาศ

public GTCaptcha4Client init(String captchaId, GTCaptcha4Config config)

              
              public GTCaptcha4Client init(String captchaId, GTCaptcha4Config config)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
captchaId	String	Captcha ID ที่ได้รับจาก backend
config	GTCaptcha4Config	วัตถุการกำหนดค่า

addOnSuccessListener(GTCaptcha4Client.OnSuccessListener)

เพิ่ม listener สำหรับผลลัพธ์การยืนยัน ซึ่งจะถูกเรียกกลับเมื่อ captcha โหลดสำเร็จและผู้ใช้ทำ captcha เสร็จสิ้น

การประกาศ

public GTCaptcha4Client addOnSuccessListener(GTCaptcha4Client.OnSuccessListener response)

              
              public GTCaptcha4Client addOnSuccessListener(GTCaptcha4Client.OnSuccessListener response)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
response	GTCaptcha4Client.OnSuccessListener	Listener สำหรับผลลัพธ์การยืนยัน

addOnFailureListener(GTCaptcha4Client.OnFailureListener)

เพิ่ม listener สำหรับการโหลด captcha ล้มเหลว ซึ่งจะถูกเรียกเมื่อเกิดข้อผิดพลาดระหว่างการโหลด captcha

การประกาศ

public GTCaptcha4Client addOnFailureListener(GTCaptcha4Client.OnFailureListener listener)

              
              public GTCaptcha4Client addOnFailureListener(GTCaptcha4Client.OnFailureListener listener)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
listener	GTCaptcha4Client.OnFailureListener	Listener สำหรับการโหลด captcha ล้มเหลว

addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener)

เพิ่ม listener สำหรับการโหลด captcha ด้านหน้าให้สำเร็จ เมื่อ captcha ด้านหน้าถูกโหลดสำเร็จ callback จะถูกเรียก หากการโหลดล่วงหน้าเสร็จสิ้น callback จะถูกเรียกทันทีหลังจากเรียก verifyWithCaptcha

การประกาศ

public GTCaptcha4Client addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener listener)

              
              public GTCaptcha4Client addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener listener)

โค้ดนี้โชว์เป็นหน้าต่างลอย

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
listener	GTCaptcha4Client.OnWebViewShowListener	Listener สำหรับการโหลด captcha ด้านหน้าสำเร็จ

verifyWithCaptcha()

เริ่มกระบวนการยืนยันและโหลด captcha

การประกาศ

public GTCaptcha4Client verifyWithCaptcha()

              
              public GTCaptcha4Client verifyWithCaptcha()

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอภิปราย

หมายเหตุ: ก่อนเรียก verifyWithCaptcha() คุณจำเป็นต้องเรียก init() addOnSuccessListener() และ addOnFailureListener มิฉะนั้นอาจเกิดข้อผิดพลาด

cancel()

ยกเลิกการยืนยันและปิดหน้าต่างการยืนยัน

การประกาศ

public void cancel()

              
              public void cancel()

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอภิปราย

หมายเหตุ: ก่อนเรียก cancel() คุณจำเป็นต้องเรียก init() addOnSuccessListener() และ addOnFailureListener มิฉะนั้นอาจเกิดข้อผิดพลาด

setLogEnable(boolean enable)

เปิดหรือปิดการตรวจสอบ log

การประกาศ

public void setLogEnable(boolean enable)

              
              public void setLogEnable(boolean enable)

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอภิปราย

การเรียก setLogEnable ควบคุมการพิมพ์ log

destroy()

ทำลายทรัพยากรที่มีอายุการใช้งานยาวนาน

การประกาศ

public void destroy()

              
              public void destroy()

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอภิปราย

ทำลายทรัพยากรการยืนยัน จำเป็นต้องเรียกเมธอดนี้

การอภิปราย

เมธอดนี้ควรถูกเรียกใน lifecycle onDestroy ของอินเทอร์เฟซ captcha ที่ใช้งานโดย client

configurationChanged(Configuration)

จัดการการเปลี่ยนแปลงการวางแนวหน้าจอ

การประกาศ

public void configurationChanged(Configuration newConfig)

              
              public void configurationChanged(Configuration newConfig)

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอภิปราย

เมธอดนี้ควรถูกเรียกในเมธอด lifecycle onConfigurationChanged ระหว่างการเปลี่ยนแปลงการวางแนวหน้าจอ

getVersion()

ดึงหมายเลขเวอร์ชัน

การประกาศ

public static String getVersion()

              
              public static String getVersion()

โค้ดนี้โชว์เป็นหน้าต่างลอย

ค่าที่ส่งกลับ

ส่งคืนหมายเลขเวอร์ชันเป็น String

isSupportWebView(Context)

ตรวจสอบว่าระบบรองรับ WebView หรือไม่ หากไม่รองรับแนะนำให้ใช้ fallback logic

การประกาศ

public static Pair<Boolean, String> isSupportWebView(Context context)

              
              public static Pair<Boolean, String> isSupportWebView(Context context)

โค้ดนี้โชว์เป็นหน้าต่างลอย

ค่าที่ส่งกลับ

รายละเอียดวัตถุ Pair:

พารามิเตอร์	ประเภท	คำอธิบาย
first	Boolean	ระบบรองรับ `WebView` หรือไม่ หากไม่รองรับสามารถใช้ fallback logic
second	String	คำอธิบายข้อผิดพลาดสำหรับการโหลดวัตถุ `WebView`