Hive SDK initialization¶

The initialization of the Hive SDK means making most of the Hive SDK features in an initialization state, that is, ready for use. When implementing the Hive SDK code, you must first execute the initialization and then call the methods for implementing the features you need.

Initialization method¶

To initialize the Hive SDK, call AuthV4.setup. It is recommended to perform the initialization after the game app runs and the corporate logo (CI) is displayed. If result.isSuccess received as a callback result is True, the initialization was successful. Here is an example code.

using hive;

    // Request Hive SDK Initialization
    AuthV4.setup((result, isAutoSignIn, did, providerTypeList) => {
        if (result.isSuccess()) {
            // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.
        } else if (result.needExit()) {
            // TODO: Implement the termination of the app
            // Users of the Cocos2d-x engine
            // ex) exit(0);
            // Unreal engine users
            // Example) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);    
        } else {
            // initialization failed 
        }
    });

#include <HIVE_SDK_Plugin/HIVE_CPP.h>

    // Request Hive SDK Initialization
    AuthV4::setup([=](ResultAPI const & result, bool isAutoSignIn, std::string did, std::vector<ProviderType> const & providerTypeList) {
        if (result.isSuccess()) {
            // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.
        } else if (result.needExit()) {
            // TODO: Implement the termination of the app
            // Users of the Cocos2d-x engine
            // ex) exit(0);
            // Unreal engine users
            // Example) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);    
        } else {
            // initialization failed 
        }
    });

import com.hive.AuthV4;

    // Request Hive SDK Initialization    
    AuthV4.setup(object: AuthV4.AuthV4SetupListener{    
        override fun onAuthV4Setup(result: ResultAPI, isAutoSignIn: Boolean, did: String?, providerTypeList: ArrayList<AuthV4.ProviderType>?) {        if (result.isSuccess) {    
                // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.    
            } else if (result.needExit()) {    
                // TODO: Implement the termination of the app    
                // ex) exitProcess(0)    
            } else {    
                // initialization failed 
            } 
        } 
    })

import com.hive.AuthV4;  

    // Request Hive SDK Initialization    
    AuthV4.setup(new AuthV4.AuthV4SetupListener() {    
        @Override    
        public void onAuthV4Setup(ResultAPI result, boolean isAutoSignIn, String did, ArrayList<AuthV4.ProviderType> providerTypeList) {    
            if (result.isSuccess()) {    
                // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.    
            } else if (result.needExit()) {    
                // TODO: Implement the termination of the app    
                // ex) System.exit(0);    
            } else {    
                // initialization failed 
            } 
        } 
    });

import HIVEService

    // Request Hive SDK Initialization
    AuthV4Interface.setup { (result, isAutoSignIn, did, providerTypeList) in    
        if result.isSuccess() {    
            // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.    
        } else if result.needExit() {    
            // TODO: Implement the termination of the app    
            // Example) exit(0)    
        } else {    
            // initialization failed    
        }    
    }

#import <HIVEService/HIVEService-Swift.h>

    // Request Hive SDK Initialization    
    [HIVEAuthV4 setup:^(HIVEResultAPI *result, BOOL isAutoSignIn, NSString *did, NSArray<NSNumber *> *providerTypeList) {    
        if (result.isSuccess) {    
            // the initialization is successfully done. Handle login based on whether the auto-login is enabled or not.    
        } else if (result.needExit) {    
            // TODO: Implement the termination of the app    
            // ex) exit(0);    
        } else {    
            // initialization failed    
        }    
    }];

#include "HiveAuthV4.h"

    FHiveAuthV4::Setup(FHiveAuthV4OnSetupDelegate::CreateLambda([this](const FHiveResultAPI& Result,
    bool IsAutoSignIn,
    const FString& Did,
    const TArray<EHiveProviderType>& ProviderTypeArray) 
    {
            if (Result.IsSuccess()) {
                    // Initialization successful. Handle login based on whether auto sign-in is possible.
            } else if (Result.NeedExit()) {
                    // TODO: Implement app exit functionality
                    // e.g.) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
            } else {
                    // Initialization failed
            }
    }));

The result callback includes the information below. You should store the information below and use it when necessary.

Initialization result¶

The Hive SDK initialization performs the following.

• Initialize Authentication, Promotion, Notification, and Marketing Attribution
• Automatically display the Terms registered in Hive Console and the Update Popup

Initialization flow¶

The workflow that the Hive SDK internally executes when AuthV4.setup is run varies depending on the region where you plan to launch your game app.

1. Regions other than the US and Europe
2. United States
3. Europe

Initialization flow: default flow¶

The image below shows the default workflow that the Hive SDK internally executes when AuthV4.setup is run. This applies when launching your game app in regions other than the US and Europe.

Initialization flow: US launch¶

The image below shows the workflow that the Hive SDK internally executes when AuthV4.setup is run. This applies when you need to comply with COPPA (Children's Online Privacy Protection Act) when launching your game app in the United States.

Initialization flow: EU launch¶

The image below shows the workflow that the Hive SDK internally executes when AuthV4.setup is run. This applies when you need to comply with GDPR (General Data Protection Regulation) when launching your game app in Europe.