คลาสการกำหนดค่า¶
การใช้คลาส Configuration
คุณสามารถ ดึงข้อมูล (get
) หรือ เปลี่ยนแปลง (set
) ค่าคอนฟิกในระหว่างการทำงานของแอป ตัวอย่างเช่น เมื่อดึงข้อมูลเซิร์ฟเวอร์แอป ให้ใช้วิธี getServerId()
และเมื่อเปลี่ยนแปลง ให้ใช้วิธี setServerId()
เป็นตัวอย่างของการใช้คลาส Configuration
คุณสามารถเปลี่ยนการตั้งค่า zone
ของผู้ใช้ระหว่างการทำงานของแอปด้วยคลาส Configuration
.
API Reference: hive.Configuration.setZone
API Reference: hive::Configuration::setZone
API Reference: Configuration.setZone
API Reference: Configuration.setZone
API Reference: ConfigurationInterface.setZone
API Reference: HIVEConfiguration:setZone
Note
เมธอด setZone
ของคลาส Configuration
ต้องถูกเรียกก่อนที่จะเรียกใช้ฟังก์ชัน setup
เพื่อให้ทำงานได้อย่างถูกต้อง。
สถานการณ์การใช้งานของคลาสการกำหนดค่า¶
หากคุณต้องการเปลี่ยนการตั้งค่า SDK ของ Hive ขณะแอปกำลังทำงาน นี่คือกรณีต่างๆ
Hive การเริ่มต้น SDK ก่อน¶
ก่อนที่จะเริ่มต้น SDK ของ Hive ให้สะท้อนเซิร์ฟเวอร์เกมหรือภาษาของเกมในการตั้งค่า
Hive การเริ่มต้น SDK ~ ก่อนป๊อปอัปการบำรุงรักษาเซิร์ฟเวอร์¶
นี่คือกรณีที่ผู้ใช้เลือกเซิร์ฟเวอร์เกมก่อนที่จะแสดงป๊อปอัปการบำรุงรักษาเซิร์ฟเวอร์หลังจากการเริ่มต้น SDK Hive หลังจากการเริ่มต้น SDK Hive UI การเลือกเซิร์ฟเวอร์เกมจะถูกเปิดเผย และเซิร์ฟเวอร์เกมที่ผู้ใช้เลือกจะถูกสะท้อนในการตั้งค่า หลังจากดำเนินการกระบวนการนี้ ป๊อปอัปการบำรุงรักษาเซิร์ฟเวอร์จะแสดงขึ้น
ตัวอย่าง: UI การเลือกเซิร์ฟเวอร์เกม
หลังจากเข้าสู่เกม¶
หากผู้ใช้เปลี่ยนภาษาเกมหรือเซิร์ฟเวอร์เกมในการตั้งค่าเกมหลังจากเข้าสู่เกมแล้ว พวกเขาสามารถกำหนดค่าหน้าจอสำหรับการเปลี่ยนเซิร์ฟเวอร์เกมหรือภาษาของเกมในการตั้งค่าเกมหรือเมนูอื่น ๆ ขณะเล่นเกม หากผู้ใช้เปลี่ยนเซิร์ฟเวอร์หรือภาษาโดยใช้หน้าจอนั้น ข้อมูลนี้จะต้องสะท้อนในการตั้งค่าด้วย
สถานการณ์อื่นๆ¶
เปลี่ยนค่าที่ตั้งไว้ก่อนหน้านี้เนื่องจากสถานการณ์ต่างๆ เช่น การเปลี่ยนแปลงข้อมูลเกมตามแผนการเกมและสถานการณ์อื่นๆ
Info
คุณไม่สามารถเปลี่ยนการตั้งค่ารันไทม์ด้วยคลาส Configuration
และยังมี รายการที่สามารถดึงข้อมูลได้เท่านั้น
ตัวอย่างการใช้คลาสการกำหนดค่า¶
นี่คือคู่มือเพิ่มเติมเกี่ยวกับการใช้คลาส Configuration
Hive การตั้งค่าธีม¶
คุณสามารถเปิดเผยธีมมืดโดยใช้ Configuration.setHiveTheme
API Reference: hive.Configuration.setHiveTheme
API Reference: hive::Configuration::setHiveTheme
API Reference: hiveTheme
API Reference: Configuration.setHiveTheme
API Reference: HIVEConfiguration:setHiveTheme
API Reference: HIVEConfiguration:setHiveTheme
คลาสการกำหนดค่าและ hive_config.xml ไฟล์¶
การเปลี่ยนแปลงการตั้งค่า (การตั้งค่าเวลาทำงาน) ด้วยวิธีการในคลาส Configuration
จะทำการเขียนทับค่าที่ตั้งไว้ใน hive_config.xml (การตั้งค่าเวลาสร้าง) กล่าวอีกนัยหนึ่ง ค่าที่ตั้งโดยคลาส Configuration
จะมีความสำคัญสูงกว่า อย่างไรก็ตาม ค่าที่ตั้งโดยคลาส Configuration
จะมีลำดับความสำคัญภายใน Hive SDK และค่าที่มีอยู่ในไฟล์ hive_config.xml
จะไม่ถูกเปลี่ยนแปลง
ตัวอย่างเช่น แม้ว่าคุณจะตั้งค่า zone
เป็น sandbox
ในการกำหนดค่า zone
ข้างต้นใน hive_config.xml หลังจากเปลี่ยนค่าดังกล่าวเป็น real
ด้วยคลาส Configuration
และทำการเริ่มต้น SDK Hive SDK จะทำงานตาม real
อย่างไรก็ตาม zone
ใน hive_config.xml จะยังคงเป็น sandbox
คลาสการกำหนดค่าสำหรับการตั้งค่าที่สามารถเรียกคืนได้¶
วิธีการของคลาสการกำหนดค่าช่วยให้คุณสามารถดึงค่า (get
) สำหรับการตั้งค่าที่มี เฉพาะ ตามที่ระบุด้านล่างเท่านั้น
รายการ | OS | Hive ฟีเจอร์ SDK | คำอธิบาย | SDK ค่าเริ่มต้น |
---|---|---|---|---|
hiveSDKVersion | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือเวอร์ชันของ Hive SDK. | ค่าเวอร์ชัน Hive SDK ที่ใช้ |
referenceSDKVersion | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือเวอร์ชัน SDK ที่อ้างอิงโดย Hive SDK. | ข้อมูลเกี่ยวกับไลบรารีและเวอร์ชันที่อ้างอิงโดย Hive SDK ที่ใช้ |
hiveCountry | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือรหัสประเทศที่กำหนดโดยเซิร์ฟเวอร์ Hive SDK. | ข้อมูลที่ให้โดยเซิร์ฟเวอร์ Hive SDK |
appId | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือรหัสระบุตัวสร้างเกม. | X |
serverId | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือรหัสระบุสำหรับแต่ละเซิร์ฟเวอร์เกมที่สามารถยืนยันได้เมื่อเกมทำงานในภูมิภาค. ต้องเขียนตามนโยบายรหัสระบุ Hive | ว่าง |
zone | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือเซิร์ฟเวอร์ที่ไคลเอนต์ Hive จะเชื่อมต่อ.
| REAL |
useLog | Android, iOS, Windows | Hive SDK ทั่วไป | นี่แสดงว่าต้องเปิดใช้งานการบันทึกสำหรับการดำเนินการภายในของไคลเอนต์ Hive หรือไม่. เมื่อเปิดใช้งานการบันทึก, บันทึกจะถูกส่งออกไปยังหน้าจอเครื่องมือพัฒนา.
| false |
channel | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือแพลตฟอร์มสำหรับการเข้าสู่ระบบและบริการสนับสนุนในแอปที่ใช้ในแอปเกม. หากเข้าสู่ระบบเครือข่ายสังคมภายนอกหรือใช้การซื้อในแอปผ่าน Hive SDK, จะตรงกับ C2S. ใช้สำหรับการรวบรวมข้อมูลการวิเคราะห์ Hive SDK.
| C2S |
market | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือการตลาดสำหรับการประมวลผลการซื้อในแอป. ใช้สำหรับการรวบรวมข้อมูลการวิเคราะห์ Hive SDK.
| ว่าง |
httpConnectTimeout | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือระยะเวลาหมดเวลาสำหรับการเชื่อมต่อ HTTP ที่ใช้ภายในโดยไคลเอนต์ Hive (เป็นวินาที). ค่าเริ่มต้นตั้งไว้ที่ 8 วินาที, และการเปลี่ยนแปลงค่านี้ถูกห้ามเว้นแต่ในกรณีพิเศษ. | 8 (หน่วย: วินาที) |
httpReadTimeout | Android, iOS, Windows | Hive SDK ทั่วไป | นี่คือระยะเวลาหมดเวลาสำหรับการอ่าน HTTP ที่ใช้ภายในโดยไคลเอนต์ Hive (เป็นวินาที). ค่าเริ่มต้นตั้งไว้ที่ 8 วินาที, และการเปลี่ยนแปลงค่านี้ถูกห้ามเว้นแต่ในกรณีพิเศษ (เช่น, ความล่าช้าของเครือข่ายหรือการหยุดชะงักที่ได้รับการยืนยันว่าเป็นอุปสรรคต่อการรวบรวมบันทึกปกติ). | 8 (หน่วย: วินาที) |
gameLanguage | Android, iOS | Hive SDK ทั่วไป | นี่คือภาษาของเกมที่ตั้งค่าใน Hive SDK. | การตั้งค่าภาษาอุปกรณ์ |
ageGateU13 | Android, iOS, Windows | Provisioning | นี่แสดงว่าต้องใช้ COPPA ageGateU13 หรือไม่. เพื่อใช้ COPPA ageGateU13 ใน Hive SDK, คุณต้องลงทะเบียนข้อกำหนด COPPA ในคอนโซล Hive และตั้งค่านี้เป็น true ก่อนเริ่มต้น Hive SDK. หากคุณไม่ต้องการใช้ COPPA ageGateU13, ตั้งค่านี้เป็น false ก่อนเริ่มต้น Hive SDK ในขณะที่ลงทะเบียนข้อกำหนดอื่นนอกเหนือจาก COPPA ในคอนโซล Hive.
| false |
agreementDetermineBase | Android, iOS | Provisioning | นี่คือการกำหนดเกณฑ์ในการขอความยินยอมต่อเงื่อนไขต่างๆ คุณสามารถเลือกได้ทั้ง device หรือ account โดยค่าเริ่มต้นคือ device .
| device |
enableGameController | Windows | Hive SDK Common | ฟีเจอร์นี้กำหนดว่าจะเปิดใช้งาน 'เกมคอนโทรลเลอร์' ใน UI ที่จัดเตรียมโดย Hive SDK หรือไม่.
get . | true |
usePrivateBrowsingForAuth | Windows | Authentication | นี่คือการกำหนดว่าจะใช้โหมดไม่ระบุตัวตนในระหว่างการเข้าสู่ระบบ Google หรือไม่.
| true |
maxGameLogSize | Android, iOS, Windows | Analytics | จำนวนสูงสุดของบันทึกเกมที่เก็บเป็นไฟล์ข้อมูลที่ไม่มีโครงสร้าง ค่าเริ่มต้นคือ 50 และค่าดังกล่าวจะถูกเก็บรวบรวมโดยเซิร์ฟเวอร์วิเคราะห์ของ HiveSDK. | 50 |
analyticsSendLimit | Android, iOS, Windows | Analytics | จำนวนสูงสุดของบันทึกที่จะถูกส่งในแต่ละรอบการส่งบันทึกวิเคราะห์ ค่าเริ่มต้นคือ 5 . | 5 |
analyticsQueueLimit | Android, iOS, Windows | Analytics | จำนวนสูงสุดของบันทึกวิเคราะห์ที่สามารถรอในคิวได้ ค่าเริ่มต้นคือ 50 . | 50 |
analyticsSendCycle | Android, iOS, Windows | Analytics | รอบการส่งบันทึกวิเคราะห์ สามารถตั้งค่าเป็นวินาที และบันทึกวิเคราะห์จะถูกส่งทุกๆ รอบที่ตั้งค่า ค่าเริ่มต้นคือ 1 วินาที. | 1 |
hiveTheme | Android, iOS, Windows | Hive SDK Common | คุณสามารถตั้งค่า Hive ธีมให้ใช้ธีมแบบสว่างหรือมืดได้. | HiveTheme.HiveLight |
การตั้งค่าที่เปลี่ยนแปลงได้ด้วยคลาสการกำหนดค่า¶
รายการที่สามารถเปลี่ยนแปลงได้ (set
) ด้วยวิธีของคลาส Configuration
มีดังนี้ รายการที่จำเป็นต้องกรอกจะต้องกรอก ขณะที่รายการที่ไม่จำเป็นสามารถกรอกได้ตามต้องการ หากไม่กรอกรายการที่ไม่จำเป็น จะทำงานด้วยค่าดีฟอลต์ของ SDK Hive แม้ว่าจะเป็นรายการที่จำเป็น หากได้กรอกไปแล้วใน hive_config.xml และไม่จำเป็นต้องเปลี่ยนแปลงในระหว่างการทำงาน ก็ไม่จำเป็นต้องเปลี่ยนแปลงด้วยคลาส Configuration
Warning
serverId
เป็นค่าที่ต้องตั้งค่าเฉพาะในระหว่างการทำงานเท่านั้น ดังนั้น ค่านี้ต้องถูกตั้งค่าผ่านคลาส Configuration
รายการ | OS | Hive SDK คุณสมบัติ | คำอธิบาย | จำเป็น | ค่าเริ่มต้นของ SDK |
---|---|---|---|---|---|
appId | Android, iOS, Windows | Hive SDK ทั่วไป | รหัสประจำตัวการสร้างเกม | X | * Android: ชื่อแพ็คเกจหลักของแอป * iOS: Bundle ID |
serverId | Android, iOS, Windows | Hive SDK ทั่วไป | รหัสประจำตัวเซิร์ฟเวอร์เกมแต่ละตัวที่สามารถตรวจสอบได้เมื่อดำเนินการเซิร์ฟเวอร์ในภูมิภาคในเกม ต้องเขียนตามนโยบายรหัสประจำตัว Hive | O | ว่าง |
zone | Android, iOS, Windows | Hive SDK ทั่วไป | เซิร์ฟเวอร์ที่ลูกค้า Hive จะเชื่อมต่อ
| X | REAL |
useLog | Android, iOS, Windows | Hive SDK ทั่วไป | ว่าจะเปิดใช้งานบันทึกสำหรับการดำเนินการภายในของลูกค้า Hive หรือไม่ เมื่อเปิดใช้งานบันทึก จะถูกส่งออกไปยังหน้าจอเครื่องมือพัฒนา
| X | false |
channel | Android, iOS, Windows | Hive SDK ทั่วไป | แพลตฟอร์มบริการสนับสนุนการเข้าสู่ระบบและการซื้อในแอปที่ใช้ในแอปเกม เมื่อเข้าสู่ระบบไปยังแพลตฟอร์มโซเชียลภายนอกหรือใช้การซื้อในแอปผ่าน Hive SDK จะตรงกับ C2S ใช้สำหรับการเก็บข้อมูลการวิเคราะห์ Hive SDK
| O | C2S |
market | Android, iOS, Windows | Hive SDK ทั่วไป | ตลาดสำหรับการประมวลผลการชำระเงินในการซื้อในแอป ใช้สำหรับการเก็บข้อมูลการวิเคราะห์ Hive SDK
| O | ว่าง |
httpConnectTimeout | Android, iOS, Windows | Hive SDK ทั่วไป | ระยะเวลาหมดอายุ (เป็นวินาที) สำหรับการเชื่อมต่อ HTTP ที่ใช้ภายในโดยลูกค้า Hive ค่าเริ่มต้นตั้งไว้ที่ 8 วินาที และการเปลี่ยนแปลงค่านี้จะถูกห้ามเว้นแต่ในกรณีพิเศษ | X | 8 (หน่วย: วินาที) |
httpReadTimeout | Android, iOS, Windows | Hive SDK ทั่วไป | ระยะเวลาหมดอายุ (เป็นวินาที) สำหรับการอ่าน HTTP ที่ใช้ภายในโดยลูกค้า Hive ค่าเริ่มต้นตั้งไว้ที่ 8 วินาที และการเปลี่ยนแปลงค่านี้จะถูกห้ามเว้นแต่ในกรณีพิเศษ (เช่น ความล่าช้าในเครือข่ายหรือการตัดการเชื่อมต่อที่ได้รับการยืนยันว่าขัดขวางการเก็บบันทึกปกติ) | X | 8 (หน่วย: วินาที) |
gameLanguage | Android, iOS, Windows | Hive SDK Common | ภาษาเกมที่ตั้งค่าใน Hive SDK | X | การตั้งค่าภาษาอุปกรณ์ |
ageGateU13 | Android, iOS, Windows | Provisioning | ว่าจะใช้ COPPA ageGateU13 หรือไม่ เพื่อใช้ COPPA ageGateU13 ใน Hive SDK ค่านี้ต้องตั้งค่าเป็น true หลังจากลงทะเบียนเงื่อนไข COPPA ในคอนโซล Hive และก่อนที่จะเริ่มต้น Hive SDK หากไม่ต้องการใช้ COPPA ageGateU13 ค่านี้ต้องตั้งค่าเป็น false หลังจากลงทะเบียนเงื่อนไขอื่นที่ไม่ใช่ COPPA ในคอนโซล Hive และก่อนที่จะเริ่มต้น Hive SDK
| X | false |
agreementDetermineBase | Android, iOS | Provisioning | กำหนดเกณฑ์ในการขอความเห็นชอบต่อเงื่อนไข คุณสามารถเลือกได้ทั้ง device หรือ account โดยค่าเริ่มต้นคือ device
| X | device |
enableGameController | Windows | Hive SDK Common | ฟีเจอร์ที่ตั้งค่าว่าจะเปิดใช้งาน 'เกมคอนโทรลเลอร์' ใน UI ที่จัดเตรียมโดย Hive SDK หรือไม่.
get . | X | true |
usePrivateBrowsingForAuth | Windows | การตรวจสอบสิทธิ์ | กำหนดว่าจะแสดงโหมดไม่ระบุตัวตนระหว่างการตรวจสอบสิทธิ์การเข้าสู่ระบบ Google หรือไม่.
| X | true |
maxGameLogSize | Android, iOS, Windows | การวิเคราะห์ | จำนวนสูงสุดของบันทึกเกมที่เก็บเป็นไฟล์ข้อมูลที่ไม่มีโครงสร้าง ค่าตั้งต้นคือ 50 และค่าดังกล่าวจะถูกเก็บโดยเซิร์ฟเวอร์การวิเคราะห์ HiveSDK. | X | 50 |
analyticsSendLimit | Android, iOS, Windows | การวิเคราะห์ | จำนวนสูงสุดของบันทึกที่จะส่งต่อรอบการส่งบันทึกการวิเคราะห์ ค่าตั้งต้นคือ 5 . | X | 5 |
analyticsQueueLimit | Android, iOS, Windows | การวิเคราะห์ | จำนวนสูงสุดของบันทึกการวิเคราะห์ที่สามารถรอคิวได้ ค่าตั้งต้นคือ 50 . | X | 50 |
analyticsSendCycle | Android, iOS, Windows | การวิเคราะห์ | นี่คือรอบการส่งบันทึกการวิเคราะห์ สามารถตั้งค่าเป็นวินาที และบันทึกการวิเคราะห์จะถูกส่งในช่วงเวลาที่กำหนด ค่าตั้งต้นคือ 1 วินาที. | X | 1 |
hiveTheme | Android, iOS, Windows | Hive SDK Common | คุณสามารถตั้งค่า Hive ธีมเพื่อใช้ธีมแบบสว่างหรือมืด. | X | HiveTheme.HiveLight |
Note
เมื่อใช้ COPPA ageGateU13 จะสามารถแสดง device(device
)-based terms consent popup ได้เท่านั้น.
เมื่อใช้ COPPA ageGateU13 หากผู้ใช้ตอบว่าตนมีอายุ 13 ปีขึ้นไปในระหว่างกระบวนการยินยอมตามเงื่อนไข Hive SDK จะไม่ใช้ COPPA ageGateU13 กับผู้ใช้นั้น อย่างไรก็ตาม ค่าที่ตั้งไว้ใน hive_config.xml (true
) จะไม่เปลี่ยนแปลง
รายการที่ไม่รองรับ¶
ต่อไปนี้เป็นวิธีการของคลาส Configuration
ที่ไม่รองรับอีกต่อไป
รายการ | OS | Hive SDK คุณสมบัติ | คำอธิบาย | จำเป็น | ค่าเริ่มต้น SDK |
---|---|---|---|---|---|
permissions | Android | Hive SDK ทั่วไป | (เลิกใช้ตั้งแต่ v4.16.3) ว่าจะขอสิทธิ์ที่ตั้งโดยประเภทสิทธิ์หรือไม่ ชื่อสิทธิ์เฉพาะสำหรับคุณสมบัติของ Android | X | ไม่มี |
hivePermissionViewOn | Android | Hive SDK ทั่วไป | (เลิกใช้ตั้งแต่ v4.162) ว่าจะแสดงป๊อปอัพการแจ้งเตือนสิทธิ์ของ Hive SDK หรือไม่
| X | true |
company | Android, iOS, Windows | Hive SDK ทั่วไป | (เลิกใช้ตั้งแต่ v4.23.0) ชื่อของบริษัทที่เผยแพร่เกม | X | ไม่มี |