iOS SDK API
GTCaptcha4SessionTaskDelegate
โปรโตคอล Delegate สำหรับงานเซสชัน captcha
gtCaptchaSession:didReceive:result:
Callback สำหรับพารามิเตอร์ผลลัพธ์ของเซสชัน captcha
การประกาศ
- (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession
didReceive:(NSString *)status
result:(nullable NSDictionary *)result;
พารามิเตอร์
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaSession | เซสชัน captcha |
| status | รหัสสถานะ @"0"/@"1": ไม่สมบูรณ์/สมบูรณ์ เมื่อ status เป็น @"1" หมายถึงสำเร็จ และผลลัพธ์ต้องการการยืนยันเพิ่มเติม |
| result | พารามิเตอร์การยืนยันผลลัพธ์ |
การอภิปราย
หลังจากได้รับพารามิเตอร์ผลลัพธ์แล้ว จำเป็นต้องส่งไปยังเซิร์ฟเวอร์ธุรกิจเพื่อทำการยืนยันพารามิเตอร์ ตัวอย่าง result:
{
pass_token = "eb6d2e064524ae96ddc99a0e6e15f95dbb234008d108f0db269f27d426bcf3c6";
gen_time = "1660894030";
captcha_output = "fI9I34MDjVi10gJO_EqXwNpN8hK0rYLEPVWSDE4W6kc1umDoTHIlD_t6YQNNpPG2tJlKR8he6WFWkkllU8goGeNVNOzhqmAm256BpK8qAEHNrOjHzkNagfIcx_A21ssPrG6YlnnHFx3PfBnbrn5fb2aKDIi0I5xmCUjxq0dsFuANLIQVtllMjkJ7-1l_j-Wz";
captcha_id = "647f5ed2ed8acb4be36784e01556bb71";
lot_number = "0861c607d519469b9117d0c6dd551fe3";
}
gtCaptchaSession:didReceiveError:
Callback สำหรับข้อผิดพลาดที่เกิดขึ้นระหว่างเซสชัน captcha
การประกาศ
- (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession
didReceiveError:(GTC4Error *)error;
พารามิเตอร์
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaSession | เซสชัน captcha |
| error | วัตถุคำอธิบายข้อผิดพลาด |
ดูเพิ่มเติม
GTCaptcha4Session
เซสชัน captcha
delegate
Delegate สำหรับงานเซสชัน captcha
การประกาศ
@property (nonatomic, weak) id<GTCaptcha4SessionTaskDelegate> delegate;
captchaID
Captcha ID สำหรับเซสชันปัจจุบัน
การประกาศ
@property (nonnull, readonly, nonatomic, strong) NSString *captchaID;
challenge
หมายเลข challenge สำหรับเซสชันปัจจุบัน
การประกาศ
@property (nullable, readonly, nonatomic, strong) NSString *challenge;
configuration
การกำหนดค่าสำหรับเซสชัน captcha ปัจจุบัน
การประกาศ
@property (nonnull, readonly, nonatomic, strong) GTCaptcha4SessionConfiguration *configuration;
sessionWithCaptchaID:
สร้างอินสแตนซ์เซสชัน captcha ใหม่
การประกาศ
+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID;
พารามิเตอร์
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaID | Captcha ID |
ค่าที่ส่งกลับ
อินสแตนซ์ GTCaptcha4Session ใหม่
sessionWithCaptchaID:configuration:
สร้างอินสแตนซ์เซสชัน captcha ใหม่
การประกาศ
+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID
configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaID | Captcha ID |
| configuration | การกำหนดค่าเซสชัน |
ค่าที่ส่งกลับ
อินสแตนซ์ GTCaptcha4Session ใหม่
initWithCaptchaID:
สร้างอินสแตนซ์เซสชัน captcha ใหม่
การประกาศ
- (instancetype)initWithCaptchaID:(NSString *)captchaID;
พารามิเตอร์
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaID | Captcha ID |
ค่าที่ส่งกลับ
อินสแตนซ์ GTCaptcha4Session ใหม่
initWithCaptchaID:configuration:
สร้างอินสแตนซ์เซสชัน captcha ใหม่
การประกาศ
- (instancetype)initWithCaptchaID:(NSString *)captchaID
configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| captchaID | Captcha ID |
| configuration | การกำหนดค่าเซสชัน |
ค่าที่ส่งกลับ
อินสแตนซ์ GTCaptcha4Session ใหม่
verify
เริ่มการยืนยัน
การประกาศ
- (void)verify;
cancel
ยกเลิกการยืนยัน
การประกาศ
- (void)cancel;
sdkVersion
รับเวอร์ชัน SDK
การประกาศ
+ (NSString *)sdkVersion;
GTCaptcha4SessionConfiguration
การกำหนดค่าเซสชัน captcha
GTC4UserInterfaceStyle
สไตล์อินเทอร์เฟซ captcha
การประกาศ
typedef NS_ENUM(NSInteger, GTC4UserInterfaceStyle) {
/** ตามสไตล์ระบบ */
GTC4UserInterfaceStyleSystem = 0,
/** สไตล์สว่าง */
GTC4UserInterfaceStyleLight,
/** สไตล์มืด */
GTC4UserInterfaceStyleDark,
/** สไตล์เริ่มต้น */
GTC4UserInterfaceStyleDefault = GTC4UserInterfaceStyleLight
};
resourcePath
เส้นทางที่สมบูรณ์สำหรับการเข้าถึงทรัพยากรแบบสแตติกจากระยะไกล ค่าเริ่มต้นเป็นค่าว่าง
การประกาศ
@property (nullable, nonatomic, strong) NSString *resourcePath;
protocol
โปรโตคอลที่ใช้สำหรับการเข้าถึงทรัพยากรแบบสแตติกจากระยะไกล ค่าเริ่มต้นคือ @“https”
การประกาศ
@property (nonatomic, strong) NSString *protocol;
userInterfaceStyle
สไตล์ของอินเทอร์เฟซและแถบสถานะ ค่าเริ่มต้นเป็นสีขาวธรรมดา
การประกาศ
@property (nonatomic, assign) GTC4UserInterfaceStyle userInterfaceStyle;
backgroundColor
สีพื้นหลัง ค่าเริ่มต้นคือโปร่งใส
การประกาศ
@property (nonatomic, strong) UIColor *backgroundColor;
debugEnable
สวิตช์สำหรับโหมดดีบัก ค่าเริ่มต้นคือปิด
การประกาศ
@property (nonatomic, assign) BOOL debugEnable;
backgroundUserInteractionEnable
การโต้ตอบกับพื้นหลัง ค่าเริ่มต้นคือเปิดใช้งาน
การประกาศ
@property (nonatomic, assign) BOOL backgroundUserInteractionEnable;
timeout
ระยะเวลาการหมดเวลาของคำขอ ค่าเริ่มต้นคือ 8 วินาที
การประกาศ
@property (nonatomic, assign) NSTimeInterval timeout;
language
ภาษา ค่าเริ่มต้นจะตามระบบ สำหรับภาษาที่ระบุให้ดูที่รหัสภาษา
การประกาศ
@property (nonatomic, strong) NSString *language;
supportedInterfaceOrientations
การหมุนหน้าจอที่รองรับ
การประกาศ
@property (assign, nonatomic) UIInterfaceOrientationMask supportedInterfaceOrientations;
additionalParameter
พารามิเตอร์เพิ่มเติม ค่าเริ่มต้นเป็นค่าว่าง พารามิเตอร์จะถูกประกอบและส่งไปยัง engagelab
การประกาศ
@property (nullable, nonatomic, strong) NSDictionary *additionalParameter;
การอภิปราย
รายการคู่คีย์-ค่า ที่รองรับมีดังนี้:
|Key |Type |คำอธิบาย|ค่าเริ่มต้น|
|---- |---- |---------- | ----------- |
| @"loading" | NSString | ตัวบ่งชี้สถานะการโหลดที่กำหนดเอง เส้นทางสัมพัทธ์ของทรัพยากรการโหลดสำหรับ WebView ที่โหลด html การตั้งค่าเป็นสตริงว่างจะยกเลิกการโหลด | @"./gt4-loading.gif" |
| @"rem" | NSNumber | ตั้งค่าอัตราส่วนการปรับขนาดทั้งหมดของ captcha | @(1) |
| @"hideBar" | NSArray<NSString *> * | ซ่อนปุ่มปิดและปุ่มรีเฟรชในอินเทอร์เฟซการตรวจสอบถัดไป การตั้งค่า @[@"close", @"refresh"] จะซ่อนทั้งปุ่มปิดและปุ่มรีเฟรช | @[] |
| @"nextWidth" | NSString | ความกว้างของป๊อปอัพ captcha ต้องการหน่วย เช่น @"300px" | nil |
| @"riskType" | NSString | ระบุรูปแบบการตรวจสอบร่วมกับการรวมการควบคุมความเสี่ยง | nil |
| @"hideSuccess" | NSNumber | ซ่อนป๊อปอัพความสำเร็จในการตรวจสอบ @(0)/@(1) หมายถึงไม่ซ่อนหรือซ่อน | @(0) |
ตัวอย่างโค้ด
#define captchaID @"1234567890abcdef"
GTCaptcha4SessionConfiguration *config = [GTCaptcha4SessionConfiguration defaultConfiguration];
NSMutableDictionary *params = [@{} mutableCopy];
[params setValue:@(1.25) forKey:@"rem"]; // ขยายขนาดขึ้น 1.25 เท่า
[params setValue:@[@"close", @"refresh"] forKey:@"hideBar"]; // ซ่อนปุ่มปิดและปุ่มรีเฟรช
[params setValue:@"300px" forKey:@"nextWidth"];
[params setValue:@"click" forKey:@"riskType"]; // ระบุการตรวจสอบการคลิกอัจฉริยะ สอดคล้องกับการกำหนดค่าด้านหลัง
[params setValue:@(1) forKey:@"hideSuccess"]; // ใช้ NSNumber เพื่อแสดงค่าบูลีน
[params setValue:@"./gt4-loading.gif" forKey:@"loading"];
config.additionalParameter = params;
GTCaptcha4Session *captchaSession = [GTCaptcha4Session sessionWithCaptchaID:captchaID configuration:config];
...
defaultConfiguration
รับค่าการกำหนดค่าเริ่มต้น
การประกาศ
+ (GTCaptcha4SessionConfiguration *)defaultConfiguration;
ค่าที่ส่งคืน
+ (GTCaptcha4SessionConfiguration *)defaultConfiguration {
GTCaptcha4SessionConfiguration *config = [[GTCaptcha4SessionConfiguration alloc] init];
config.debugEnable = NO;
config.timeout = 8.0;
config.language = [GTC4Utils systemLanguage];
config.protocol = @"https";
config.userInterfaceStyle = GTC4UserInterfaceStyleDefault;
config.backgroundColor = [UIColor clearColor];
config.backgroundUserInteractionEnable = YES;
return config;
}
Error
วัตถุคำอธิบายข้อผิดพลาด
/// พารามิเตอร์ไม่ถูกต้อง โปรดตรวจสอบพารามิเตอร์ที่ป้อน
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeInvalidParameter;
/// การดำเนินการล้มเหลว ตรวจสอบคำอธิบายสำหรับรายละเอียด
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeOperationFail;
/// ทรัพยากรหายไป โปรดตรวจสอบว่าไฟล์ GTCaptcha4.bundle สมบูรณ์หรือไม่
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeMissedResource;
/// ผู้ใช้ยกเลิกการตรวจสอบ
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUserDidCancel;
/// ล้มเหลวในการโหลดไฟล์ โปรดตรวจสอบว่าไฟล์ GTCaptcha4.bundle สมบูรณ์หรือไม่ หรือทรัพยากรแบบสแตติกที่กำหนดค่าจากระยะไกลสามารถเข้าถึงได้หรือไม่
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeLoadFileFailure;
/// การโหลดหมดเวลา
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeTimeout;
/// ล้มเหลวในการดำเนินการสคริปต์ Javascript
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeEvaluatingJavascriptFail;
/// Javascript ส่งคืนข้อผิดพลาด
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeJavascriptError;
/// คำเตือนหน่วยความจำ WebView
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeWebViewMemoryWarning;
/// ข้อผิดพลาดที่ไม่รู้จัก
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUnknown;
code
รหัสข้อผิดพลาด สามารถใช้สำหรับการจับคู่และการจัดการ
การประกาศ
@property (readonly, nonatomic, strong) NSString *code;
ดูเพิ่มเติม
อ้างอิงรายการรหัสข้อผิดพลาดด้านบน
msg
ข้อความข้อผิดพลาด สามารถแสดงบนอินเทอร์เฟซผู้ใช้
การประกาศ
@property (readonly, nonatomic, strong) NSString *msg;
desc
คำอธิบายข้อผิดพลาดโดยละเอียด ใช้สำหรับการแก้ไขปัญหาโดยละเอียด
การประกาศ
@property (readonly, nonatomic, strong) NSDictionary *desc;
การอภิปราย
สามารถใช้เพื่อสนับสนุนปัญหาการดำเนินงานสำหรับผู้ใช้ที่ใช้การตรวจสอบ










