Hive Axyl SDK reference
Specifications of the modules, interfaces, methods, and data types that the Hive Axyl SDK provides. For how to read the specifications and the common conventions, see Reference conventions.
Modules
The Hive Axyl SDK is a combination of feature-based modules. All feature modules depend on the common runtime com.com2usplatform.hiveaxyl.core, so when you install any feature module, Core is installed with it. All modules require Unity 6000.0 or later.
Windows builds
In Windows builds, com.com2usplatform.hiveaxyl.core, com.com2usplatform.hiveaxyl.storage, and com.com2usplatform.hiveaxyl.auth.addon.webauth include native plugins, so the Microsoft Visual C++ 2015-2022 Redistributable (x64) must be installed on every device that runs the app.
All feature modules depend on com.com2usplatform.hiveaxyl.core, so when you install any feature module, this requirement applies as well. In environments where it is not installed, DllNotFoundException is thrown during initialization, in the Windows Editor as well as in built players.
Module structure
Modules are divided into the following three types.
Runtime modules
The SDK runtime that every app uses, and base modules that other modules use in common. The SDK runtime provides initialization, service retrieval, and the result and error models, and base modules provide the external integration environment that other modules need.
Server API modules
Modules that call the Hive Axyl server over HTTPS. They have no platform restrictions.
Add-on and platform-restricted modules
Modules that wrap native OS or store features. Modules whose names contain addon, and com.com2usplatform.hiveaxyl.storage, fall into this category. They are registered only on supported platforms, so check with HiveCore.TryResolve<T>() before you use them.
Runtime
| Module | Package | Supported platforms | Description | Reference |
|---|---|---|---|---|
core | com.com2usplatform.hiveaxyl.core | All | The SDK runtime that provides initialization, service retrieval, and the result and error models | Reference |
steamworks | com.com2usplatform.hiveaxyl.steamworks | Windows, macOS | The Steamworks integration base module that the Steam login and payment Add-ons use in common | Reference |
Account and login
| Module | Package | Supported platforms | Minimum requirements | Description | Reference |
|---|---|---|---|---|---|
auth | com.com2usplatform.hiveaxyl.auth | All (server API) | — | Guest, username, and external authentication provider login, account linking and unlinking, and token issuance | Reference |
auth.addon.apple | com.com2usplatform.hiveaxyl.auth.addon.apple | iOS, macOS | iOS 17+, macOS 15+ | Sign in with Apple authentication Add-on | Reference |
auth.addon.credentialmanager | com.com2usplatform.hiveaxyl.auth.addon.credentialmanager | Android | Android API 29+ | Android unified credential login Add-on that wraps AndroidX Credential Manager | Reference |
auth.addon.gpg | com.com2usplatform.hiveaxyl.auth.addon.gpg | Android | Android API 29+ | Google Play Games login Add-on that wraps the Play Games Services v2 GamesSignInClient | Reference |
auth.addon.steam | com.com2usplatform.hiveaxyl.auth.addon.steam | Windows, macOS | macOS 15+ | Steam authentication Add-on that uses the Steamworks session ticket API | Reference |
auth.addon.webauth | com.com2usplatform.hiveaxyl.auth.addon.webauth | Android, Windows, iOS, macOS | Android API 29+, iOS 17+, macOS 15+ | Web authentication Add-on that uses an OAuth external user agent | Reference |
Payment
| Module | Package | Supported platforms | Minimum requirements | Description | Reference |
|---|---|---|---|---|---|
payments | com.com2usplatform.hiveaxyl.payments | All (server API) | — | Hive Axyl payment service API | Reference |
payments.addon.apple | com.com2usplatform.hiveaxyl.payments.addon.apple | iOS, macOS | iOS 17+, macOS 15+ | Apple StoreKit in-app purchase Add-on | Reference |
payments.addon.google | com.com2usplatform.hiveaxyl.payments.addon.google | Android | Android API 29+ | Google Play payment Add-on that wraps the Google Play Billing Library 9 BillingClient | Reference |
payments.addon.steam | com.com2usplatform.hiveaxyl.payments.addon.steam | Windows, macOS | macOS 15+ | Steam Microtransactions Add-on that handles Steamworks payment authorization callbacks | Reference |
Push notifications
| Module | Package | Supported platforms | Minimum requirements | Description | Reference |
|---|---|---|---|---|---|
push | com.com2usplatform.hiveaxyl.push | All (server API) | — | APIs for registering device tokens, changing the token language and notification consent, and detaching the user | Reference |
push.addon.apns | com.com2usplatform.hiveaxyl.push.addon.apns | iOS, macOS | iOS 17+, macOS 15+ | Apple Push Notification service (APNs) Add-on | Reference |
push.addon.applenotification | com.com2usplatform.hiveaxyl.push.addon.applenotification | macOS | macOS 15+ | Apple local push notification Add-on that schedules, cancels, and retrieves local push notifications | Reference |
push.addon.fcm | com.com2usplatform.hiveaxyl.push.addon.fcm | Android | Android API 29+ | Firebase Cloud Messaging device token Add-on that wraps FirebaseMessaging | Reference |
Other features
| Module | Package | Supported platforms | Minimum requirements | Description | Reference |
|---|---|---|---|---|---|
mailbox | com.com2usplatform.hiveaxyl.mailbox | All (server API) | — | Hive Axyl mailbox API that provides sending and recalling mail, retrieving sent and received mail, marking mail as read, and deletion | Reference |
serviceaccess | com.com2usplatform.hiveaxyl.serviceaccess | All (server API) | — | Service access control API that provides server maintenance retrieval, client update checks, and service country restriction checks | Reference |
storage | com.com2usplatform.hiveaxyl.storage | Android, Windows, iOS, macOS | Android API 29+, iOS 17+, macOS 15+ | Key-value storage module that encrypts values and keeps them in the device's secure storage | Reference |
coupon | com.com2usplatform.hiveaxyl.coupon | All (server API) | — | Hive Axyl coupon API that redeems coupon codes and grants the coupon's items to the mailbox | Reference |
analytics | com.com2usplatform.hiveaxyl.analytics | All (server API) | — | API that sends the app client's log events to the Hive Axyl analytics log server | Reference |
tcb | com.com2usplatform.hiveaxyl.tcb | All (server API) | — | API that runs Cloud Functions registered in Tencent CloudBase (TCB) | Reference |