‹ HMS Doc Home

Huawei Mobile Services Integration Guide

For the C++ version of cocos2d-x v3.x - (all other versions)

Integration

Open a terminal and use the following command to install the SDKBOX HMS plugin. Make sure you setup the SDKBOX installer correctly.

$ sdkbox import hms

Important Notice

Please make sure the following settings in your project to make the plugin work well.

Disable App Transport Security

Adding the following entry to the info.plist file:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

It should look like this:

Disable Bitcode support

You have to turn off Bitcode support. If you don't, cocos2d-x will fail to build.

Set your game requires full screen

If your game doesn't support all screen orientations, you will need to check Requires full screen in Xcode. If you do not, your app will fail Apple's submission process.

Whitelist canOpenURL function

This setting depends on what plugins are in your project. You may need to add the required entry to the info.plist, under LSApplicationQueriesSchemes.

Extra steps

Android Steps

you should add this code com.sdkbox.plugin.PluginHMS.ApplicationInit(this); to Application::onCreate. modification may like follow (create a new Application class if it not exist):

public class YourApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        com.sdkbox.plugin.PluginHMS.ApplicationInit(this); // add this line
    }

    ...
}

Configuration

SDKBOX Installer will automatically inject a sample configuration to your sdkbox_config.json, that you have to modify it before you can use it for your own app.

Here is an example of the HMS configuration.

"ios" :
{
    "hms":{
    }
},
"android":
{
    "hms":{
        "archive": true,
        "key": "MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAn9U6yC1QI8cXGRkOQxO9QG/WV8dR4jZDCYt/GJBM4OTTtRZeAIEyVifGPutwMAkPBLgdUsJwHuA2t2jrBAi/nagYJvh8UIazKJv5C4Hykw5Z2iKTWMmiMK9rQ2tMtRTAMiY+LwfaOH2258bEyt8mDQxyG3aRSAH28mZki/nGEbNfx7ZY9By/SSkuaCEWRDNYdiWkGDuZLhf8D97DoJJc6tTnrDPmzf1QqkVDjjudkHJwgCMWpLVACzGGuo4YQYt98Pu9cqbiYWJqSHqEbPYN0AmGXdJw+tO5f1wPcZWnJhn4JqCFmD9i/dSENNJWXVDgJc0DG2PiWX5j+qUaT7WkZMs4/WFtL6VRdRUDzITqYwKUUBYENVvkfdKlhjh+6V4BFKPsipvjOsRdXDpZ7sC6MY/7yn0eMOH3RoIQoiWeGYkxRTkKhdm/QQ/Xv/dvMbiicsNmUIkBce3w4hQG9XlhgjNrl5rI4p9Ho3Stq48s7DJlhWuUE6pXcjo2TJUSJ9+nAgMBAAE=",
        "items": {
            "remove_ads": {
                "type": "non_consumable",
                "id": "com.sdkbox.test.app.sample.noad"
            },
            "coin": {
                "id": "com.sdkbox.test.app.sample.coin1"
            },
            "vip": {
                "type": "subs",
                "id": "com.sdkbox.test.app.sample.vip"
            }
        },
        "achievements": [{
            "name": "freshman",
            "id": "A7346279E90AB8910AAC0CB71E552BFA2505DFD7591C79457F84D6B95F50FFEC",
            "incremental": false
        }, {
            "name": "3shoot",
            "id": "BA8B1A486D422AEF28FF82F9BFF85C3F156824396E0BB62D92BECC63C3CAC46A",
            "incremental": true
        }, {
            "name": "5shoot",
            "id": "001D38EC9E1A80A52ED3F47BFBA35F4B5BDF3776180A2B9AD778800C45CD6540",
            "incremental": true
        }],
        "events": [{
            "name": "gencoin",
            "id": "912764D10F0988B9DCB041A4E6FE453BCBDEDC4E35708A60E33C2DEBF05F2D2E"
        }, {
            "name": "consumecoin",
            "id": "E8688F3D9625572F462F5999E7F83EB5628E0FC1F2044E84D026EC4AB33C09F5"
        }],
        "rankings": [{
            "name": "shooter",
            "id": "C8B96FA1EDFC2D87DFE9491409440E3F8B2E39AFB8BD7E95C3BE337FC207C253"
        }]
    }
}

And you must download agconnect-services.json from HMS developer site, and put it in proj.android/app.

HMS for iOS

• HMS is not supported iOS, we implement empty on iOS.

Test HMS for android

1. Create App in AppGallery
2. Enable Module you need(enable AccountKit if you need)
3. Configure app signature
4. download app info agconnect-services.json

HMS official Document

Usage

Initialize HMS

Initialize the plugin where appropriate in your code. We recommend to do this in the AppDelegate::applicationDidFinishLaunching() or AppController:didFinishLaunchingWithOptions(). Make sure to include the appropriate headers:

#include "PluginHMS/PluginHMS.h"
AppDelegate::applicationDidFinishLaunching()
{
     sdkbox::PluginHMS::init();
}

Login

HMS provides three way to login.

• Signing In with HUAWEI ID(ID Token)

sdkbox::PluginHMS::login(1);

• Signing In with HUAWEI ID(Authorization Code)

sdkbox::PluginHMS::login(2);

• Silently Signing In With HUAWEI ID

Authorization is required only at the first sign-in to your app using a HUAWEI ID. Subsequent sign-ins using the same HUAWEI ID does not require any authorization.

sdkbox::PluginHMS::login(0);

onLogin will be triggered when HMS AccountKit reruns the login response.

HMS offical documentation

Logout

sdkbox::PluginHMS::logout();

Request Managed Products

sdkbox::PluginHMS::iapRequestProducts();

this method will trigger onIAPProducts event

Purchase Managed Product

sdkbox::PluginHMS::iapPurchase("coin");

this method will trigger onIAPPurchase event

Purchase Unmanaged Product

const std::string productInfo = R"(
{
  "priceType": 0, //0:consumable 1:non-consumable 2:subscription
  "productName": "product name",
  "productId": "product id",
  "amount": "1.00",
  "currency": "CNY",
  "country": "CN",
  "sdkChannel": "1", // sdkChannel size must be between 0 and 4
  "serviceCatalog": "X58",
  "reservedInfor": "{\"a\": 1, \"b\":\"s\"}", // reservedInfor must be json string
  "developerPayload": "payload1"
}
)";
sdkbox::PluginHMS::iapPurchaseWithPrice(productInfo);

this method will trigger onIAPPurchase event

request owned purchase

will return current user own products, include non-consumable, subscription product and consumable product which have not be consumed.

sdkbox::PluginHMS::iapRequestOwnedPurchases();

this method will trigger onIAPOwnedPurchases event

consume product

sdkbox::PluginHMS::iapConsume(purchaseToken);

this method will trigger onIAPPConsume event

request owned purchase record

request current user's all purchase records.

sdkbox::PluginHMS::iapRequestOwnedPurchaseRecords(purchaseToken);

this method will trigger onIAPOwnedPurchaseRecords event

Player Info

GetPlayer Info

will trigger listener event onPlayerInfo

sdkbox::PluginHMS::playerRequestInfo();

GetPlayer ExtraInfo

Will return follow info of current player: isadult, playtime and so on will trigger listener event onPlayerExtraInfo

sdkbox::PluginHMS::playerRequestInfo();

Submit GameBegin

submit player game begin event. if your game will sell in china, you should submit game begin event. will trigger listener event onPlayerGameBegin

sdkbox::PluginHMS::playerSubmitGameBegin();

Submit GameEnd

submit player game begin event. if your game will sell in china, you should submit game end event.

will trigger listener event onPlayerGameEnd

sdkbox::PluginHMS::playerSubmitGameEnd();

Achievement

Request Achievement List

request achivement list, then you can show achievement list by yourself

will trigger listener event onAchievementList

sdkbox::PluginHMS::achievementRequestList();

AchievementShow

show achivement with hms default ui

will trigger listener event onAchievementShow

sdkbox::PluginHMS::achievementShow();

achievementVisualize

will trigger listener event onAchievementVisualize

sdkbox::PluginHMS::achievementVisualize();

achievementGrow

will trigger listener event onAchievementGrow

sdkbox::PluginHMS::achievementGrow();

achievementMakeSteps

will trigger listener event onAchievementMakeSteps

sdkbox::PluginHMS::achievementMakeSteps();

achievementReach

sdkbox::PluginHMS::achievementReach();

Event

eventGrow

sdkbox::PluginHMS::eventGrow();

eventRequestList

will trigger listener event onEventList

sdkbox::PluginHMS::eventRequestList();

Ranking

Check ranking switch status

before invoke ranking related api, you must make sure player is allow to open score.

will trigger listener event onRankingSwitchStatus

sdkbox::PluginHMS::rankingRequestSwitchStatus();

will trigger listener event onRankingSetSwitchStatus

sdkbox::PluginHMS::rankingSetSwitchStatus();

submit score

will trigger listener event onRankingSubmitScore

sdkbox::PluginHMS::rankingSubmitScore(rankingName, score, score_unit);

Show ranking

show ranking by self.

will trigger listener event onRankingList

bool realtime = true; // true, will request data from hms server; false, will use local cache data
sdkbox::PluginHMS::rankingRequestList(realtime, rankingName);

show with hms default ui

will trigger listener event onRankingShow

int timeDimension = 2; // 0-> day, 1-> week, 2-> all time
sdkbox::PluginHMS::rankingShow(timeDimension, rankingName);

get scores

current player score

will trigger listener event onRankingCurPlayerScore

int timeDimension = 2; // 0-> day, 1-> week, 2-> all time
sdkbox::PluginHMS::rankingRequestCurPlayerScore(rankingName, timeDimension);

request player centered score

will trigger listener event onRankingPlayerCenteredScores

int timeDimension = 2; // 0-> day, 1-> week, 2-> all time
sdkbox::PluginHMS::rankingRequestPlayerCenteredScores(rankingName, timeDimension, realtime);

Archive

add archive

will trigger listener event onArchiveAdd

sdkbox::PluginHMS::archiveAdd(playedTime, progress, description, supportCache,
                               bmBytes, bmBytesLen, bmBytesType,
                               dataBytes, dataBytesLen);

update archive

will trigger listener event onArchiveUpdate

sdkbox::PluginHMS::archiveUpdate(archiveId,
                          playedTime, progress, description,
                          bmBytes, bmBytesLen, bmBytesType,
                          dataBytes, dataBytesLen);

load archive

will trigger listener event onArchiveLoad

int conflictPolicy = 3;
//-1 -> hms willn't hand conflict, 
//1  -> hms will resolved conflict by played time, 
//2  -> hms will resolved conflict by progress,
//3  -> hms will resolved conflict by last update time
sdkbox::PluginHMS::archiveLoad(archiveId, conflictPolicy);

BUOY

if you game sell in china, you should show buoy

sdkbox::PluginHMS::buoyShow();
//or
sdkbox::PluginHMS::buoyHide();

Advertisement

caceh ad

sdkbox::PluginHMS::adCache(adName);

show ad

if (sdkbox::PluginHMS::adIsAvailable(adName)) {
    sdkbox::PluginHMS::adShow(adName);
}

hide banner

sdkbox::PluginHMS::adHide(adName);

ad request settings (Optional)

/*
  * adContentClassification:
  *   "W"->Content suitable for toddlers and older audiences;
  *  "PI"->Content suitable for kids and older audiences
  *   "J"->Content suitable for teenagers and older audiences.
  *   "A"->Content suitable only for adults.
  *    ""->Unknown rating.
  */
sdkbox::PluginHMS::adSetAdContentClassification("A");

/*
  * tagForUnderAgeOfPromise:
  *  0->Do not process ad requests as directed to users under the age of consent;
  *  1->Process ad requests as directed to users under the age of consent;
  * -1->Whether to process ad requests as directed to users under the age of consent is not specified;
  */
sdkbox::PluginHMS::adSetTagForUnderAgeOfPromise(0);

/*
* tagForChildProtection:
*  0->Do not process ad requests according to the COPPA;
*  1->Process ad requests according to the COPPA;
* -1->Whether to process ad requests according to the COPPA is not specified;
*/
sdkbox::PluginHMS::adSetTagForChildProtection(0);

/*
* nonPersonalizedAd
*  0->Request both personalized and non-personalized ads (default);
*  1->Request only non-personalized ads;
*/
sdkbox::PluginHMS::adSetNonPersonalizedAd(0);

reward ad setting (Optional)

reward data must be URL-encoded and length must be less than 1024

// reward ad custom data
sdkbox::PluginHMS::adSetRewardData("cdata");

// uid for reward ad
sdkbox::PluginHMS::adSetRewardUserId("uid666");

Handling HMS Events

This allows you to catch the HMS events so that you can perform operations based upon the response from your players and HMS servers.

all listener include code param, you can find code in follow url:

• https://developer.huawei.com/consumer/cn/doc/development/HMS-References/game-return-code-v4
• https://developer.huawei.com/consumer/cn/doc/development/HMS-References/hms-error-code

here we list a specific code:

• 7020: havn't find data in local cache
• 7022: is not adult
• 7024: huawei mobile market app is not installed
• 7218: huawei game services is not enabled, or user cancel
• 7204: need install the last application assist

• 7013: not login or archive is not enabled (make sure archive is true in sdkbox_config.json).

• Allow your class to extend sdkbox::HMSListener:

#include "PluginHMS/PluginHMS.h"
class MyClass : public sdkbox::HMSListener {
private:
  // Account
  virtual void onLogin(int code, const std::string &msg) override;

  // Player Info
  virtual void onPlayerInfo(int code, const std::string& errorOrJson) override;
  virtual void onPlayerExtraInfo(int code, const std::string& errorOrJson) override;
  virtual void onPlayerGameBegin(int code, const std::string& errorOrJson) override;
  virtual void onPlayerGameEnd(int code, const std::string& errorOrJson) override;

  // IAP
  virtual void onIAPReady(int code, const std::string& msg) override;
  virtual void onIAPProducts(int code, const std::string& errorOrJson) override;
  virtual void onIAPPurchase(int code, const std::string& errorOrJson) override;
  virtual void onIAPPConsume(int code, const std::string& errorOrJson) override;
  virtual void onIAPOwnedPurchases(int code, const std::string& errorOrJson) override;
  virtual void onIAPOwnedPurchaseRecords(int code, const std::string& errorOrJson) override;

  // Achievement
  virtual void onAchievementList(int code, const std::string& errorOrJson) override;
  virtual void onAchievementShow(int code, const std::string& errorOrJson) override;
  virtual void onAchievementVisualize(int code, const std::string& errorOrJson) override;
  virtual void onAchievementGrow(int code, const std::string& errorOrJson) override;
  virtual void onAchievementMakeSteps(int code, const std::string& errorOrJson) override;

  // Event
  virtual void onEventList(int code, const std::string& errorOrJson) override;

  // Ranking
  virtual void onRankingSwitchStatus(int code, const std::string& errorOrJson) override;
  virtual void onRankingSetSwitchStatus(int code, const std::string& errorOrJson) override;
  virtual void onRankingSubmitScore(int code, const std::string& errorOrJson) override;
  virtual void onRankingShow(int code, const std::string& errorOrJson) override;
  virtual void onRankingList(int code, const std::string& errorOrJson) override;
  virtual void onRankingCurPlayerScore(int code, const std::string& errorOrJson) override;
  virtual void onRankingPlayerCenteredScores(int code, const std::string& errorOrJson) override;
  virtual void onRankingMoreScores(int code, const std::string& errorOrJson) override;
  virtual void onRankingTopScores(int code, const std::string& errorOrJson) override;

  // Archive
  virtual void onArchiveLimitThumbnailSize(int code, const std::string& errorOrJson) override;
  virtual void onArchiveLimitDetailsSize(int code, const std::string& errorOrJson) override;
  virtual void onArchiveAdd(int code, const std::string& errorOrJson) override;
  virtual void onArchiveShow(int code, const std::string& errorOrJson) override;
  virtual void onArchiveSummaryList(int code, const std::string& errorOrJson) override;
  virtual void onArchiveSelect(int code, const std::string& errorOrJson) override;
  virtual void onArchiveThumbnail(int code, const std::string& errorOrJson, unsigned char* coverData, unsigned int coverDataLen) override;
  virtual void onArchiveUpdate(int code, const std::string& errorOrJson) override;
  virtual void onArchiveLoad(int code, const std::string& errorOrJson, unsigned char* contentData, unsigned int contentDataLen) override;
  virtual void onArchiveRemove(int code, const std::string& errorOrJson) override;

  // Game Stats
  virtual void onGamePlayerStats(int code, const std::string& errorOrJson) override;
  virtual void onGameSummary(int code, const std::string& errorOrJson) override;

  // Ad
  virtual void onAdClose(int code, const std::string& errorOrJson) override;
  virtual void onAdFail(int code, const std::string& errorOrJson) override;
  virtual void onAdLeave(int code, const std::string& errorOrJson) override;
  virtual void onAdOpen(int code, const std::string& errorOrJson) override;
  virtual void onAdLoad(int code, const std::string& errorOrJson) override;
  virtual void onAdClick(int code, const std::string& errorOrJson) override;
  virtual void onAdImpression(int code, const std::string& errorOrJson) override;
  virtual void onAdReward(int code, const std::string& errorOrJson) override;

}

• Create a listener that handles callbacks:

sdkbox::PluginHMS::setListener(listener);

Remote Configuration

Optionally, you can choose to use SDKBOX LiveOps to remotely update this plugin's configuration. Learn more

API Reference

Methods

static void setGDPR ( bool enabled ) ;

Set GDPR

static bool init ( ) ;

initialize the plugin instance.

static void setListener ( HMSListener * listener ) ;

Set listener to listen for adcolony events

static HMSListener * getListener ( ) ;

Get the listener

static void removeListener ( ) ;

Remove the listener, and can't listen to events anymore

static void login ( int loginType ) ;

HMS provider three way to login loginType: 0, slient login 1, login with HuaweiID(ID Token) 2, login with HuaweID(Authorization Code)

static void logout ( ) ;

logout HMS

static void playerRequestInfo ( ) ;

request current player info

static void playerRequestExtraInfo ( ) ;

request player extra info

static void playerSubmitGameBegin ( ) ;

submit game begin event

static void playerSubmitGameEnd ( ) ;

submit game end event

static void iapRequestProducts ( ) ;

static void iapPurchase ( const std::string & name ) ;

static void iapPurchaseWithPrice ( const std::string & productJson ) ;

static void iapRequestOwnedPurchases ( ) ;

static void iapConsume ( const std::string & purchaseToken ) ;

static void iapRequestOwnedPurchaseRecords ( ) ;

static void achievementRequestList ( ) ;

static void achievementShow ( ) ;

static void achievementVisualize ( const std::string & name ) ;

static void achievementGrow ( const std::string & achiveName , int steps ) ;

static void achievementMakeSteps ( const std::string & achiveName ,
                                   int steps ) ;

static void achievementReach ( const std::string & achiveName ) ;

static void eventGrow ( const std::string & eventName , int amount ) ;

static void eventRequestList ( bool realtime ,
                               const std::string & eventNamas = "" ) ;

static void rankingRequestSwitchStatus ( ) ;

request if player allow open score in ranking

static void rankingSetSwitchStatus ( int status ) ;

request if player allow open score in ranking status: 0->player allow submit score, 1->player not allow submit score

static void rankingSubmitScore ( const std::string & rankingName ,
                                 long score ,
                                 const std::string unit = "" ) ;

submit score to ranking

static void rankingShow ( int timeDimension ,
                          const std::string & rankingName = "" ) ;

use hms's ui to show ranking

static void rankingRequestList ( bool realtime ,
                                 const std::string & rankingName = "" ) ;

request ranking list

static void rankingRequestCurPlayerScore ( const std::string & rankingName ,
                                           int timeDimension ) ;

request current player ranking score

static void rankingRequestPlayerCenteredScores ( const std::string & rankingName ,
                                                 int timeDimension ,
                                                 int size ,
                                                 bool realtime ) ;

request player centered scores

static void rankingRequestMoreScores ( const std::string & rankingName ,
                                       int timeDimension ,
                                       int offset ,
                                       int pageSize ,
                                       int pageDirection ) ;

request more scores

static void rankingRequestTopScores ( const std::string & rankingName ,
                                      int timeDimension ,
                                      int offset ,
                                      int pageSize ,
                                      int pageDirection ) ;

submit score to ranking

static void archiveRequestLimitThumbnailSize ( ) ;

get thumbnail max size

static void archiveRequestLimitDetailsSize ( ) ;

get detail max size

static void archiveAdd ( long playedTime ,
                         long progress ,
                         const std::string & description ,
                         bool supportCache ,
                         const unsigned char * bmBytes ,
                         int bmBytesLen ,
                         const std::string & bmBytesType ,
                         const unsigned char * dataBytes ,
                         int dataBytesLen ) ;

add archive

static void archiveShow ( const std::string & title ,
                          bool allowAdd ,
                          bool allowDelete ,
                          int pageSize ) ;

use hms's default ui to show archive

static void archiveRequestSummaryList ( bool realtime ) ;

request archive summay list, developer can show custome archive list with the returned data

static void archiveRequestThumbnail ( const std::string & archiveId ) ;

request archive cover thumbnail

static void archiveUpdate ( const std::string & archiveId ,
                            long playedTime ,
                            long progress ,
                            const std::string & description ,
                            const unsigned char * bmBytes ,
                            int bmBytesLen ,
                            const std::string & bmBytesType ,
                            const unsigned char * dataBytes ,
                            int dataBytesLen ) ;

update archive

static void archiveLoad ( const std::string & archiveId , int conflictPolicy ) ;

load archive

static void archiveRemove ( const std::string & archiveId ) ;

remvoe archive

static void gamePlayerStatsRequest ( bool realtime ) ;

request game player statistics

static void gameSummaryRequest ( bool realtime ) ;

request game summary

static void buoyShow ( ) ;

static void buoyHide ( ) ;

static void adCache ( const std::string & name ) ;

static void adShow ( const std::string & name ) ;

static void adHide ( const std::string & name ) ;

static bool adIsAvailable ( const std::string & name ) ;

static void adSetRewardData ( const std::string & custom_data ) ;

static void adSetRewardUserId ( const std::string & user_id ) ;

static void adSetAdContentClassification ( const std::string & adContentClassification ) ;

static void adSetTagForUnderAgeOfPromise ( int tagForUnderAgeOfPromise ) ;

static void adSetTagForChildProtection ( int tagForChildProtection ) ;

static void adSetNonPersonalizedAd ( int nonPersonalizedAd ) ;

Listeners

void onLogin ( int code , const std::string & errorOrJson );

void onPlayerInfo ( int code , const std::string & errorOrJson ) {

void onPlayerExtraInfo ( int code , const std::string & errorOrJson ) {

void onPlayerGameBegin ( int code , const std::string & errorOrJson ) {

void onPlayerGameEnd ( int code , const std::string & errorOrJson ) {

void onIAPReady ( int code , const std::string & errorOrJson ) {

void onIAPProducts ( int code , const std::string & errorOrJson ) {

void onIAPPurchase ( int code , const std::string & errorOrJson ) {

void onIAPConsume ( int code , const std::string & errorOrJson ) {

void onIAPOwnedPurchases ( int code , const std::string & errorOrJson ) {

void onIAPOwnedPurchaseRecords ( int code , const std::string & errorOrJson ) {

void onAchievementList ( int code , const std::string & errorOrJson ) {

void onAchievementShow ( int code , const std::string & errorOrJson ) {

void onAchievementVisualize ( int code , const std::string & errorOrJson ) {

void onAchievementGrow ( int code , const std::string & errorOrJson ) {

void onAchievementMakeSteps ( int code , const std::string & errorOrJson ) {

void onEventList ( int code , const std::string & errorOrJson ) {

void onRankingSwitchStatus ( int code , const std::string & errorOrJson ) {

void onRankingSetSwitchStatus ( int code , const std::string & errorOrJson ) {

void onRankingSubmitScore ( int code , const std::string & errorOrJson ) {

callback for rankingSubmitScore

void onRankingShow ( int code , const std::string & errorOrJson ) {

callback for rankingShow

void onRankingList ( int code , const std::string & errorOrJson ) {

callback for rankingRequestList

void onRankingCurPlayerScore ( int code , const std::string & errorOrJson ) {

callback for rankingRequestCurPlayerScore

void onRankingPlayerCenteredScores ( int code ,
                                     const std::string & errorOrJson ) {

callback for rankingRequestPlayerCenteredScores

void onRankingMoreScores ( int code , const std::string & errorOrJson ) {

callback for rankingRequestMoreScores

void onRankingTopScores ( int code , const std::string & errorOrJson ) {

callback for rankingRequestTopScores

void onArchiveLimitThumbnailSize ( int code ,
                                   const std::string & errorOrJson ) {

callback for archiveRequestLimitThumbnailSize

void onArchiveLimitDetailsSize ( int code , const std::string & errorOrJson ) {

callback for archiveRequestLimitDetailsSize

void onArchiveAdd ( int code , const std::string & errorOrJson ) {

callback for archiveAdd

void onArchiveShow ( int code , const std::string & errorOrJson ) {

callback for archiveShow

void onArchiveSummaryList ( int code , const std::string & errorOrJson ) {

callback for archiveRequestSummaryList

void onArchiveSelect ( int code , const std::string & errorOrJson ) {

callback when user select archive

void onArchiveThumbnail ( int code ,
                          const std::string & errorOrJson ,
                          unsigned char * coverData ,
                          unsigned int coverDataLen ) {

callback for archiveRequestThumbnail

void onArchiveUpdate ( int code , const std::string & errorOrJson ) {

callback for archiveUpdate

void onArchiveLoad ( int code ,
                     const std::string & errorOrJson ,
                     unsigned char * contentData ,
                     unsigned int contentDataLen ) {

callback for archiveLoad

void onArchiveRemove ( int code , const std::string & errorOrJson ) {

callback for archiveRemove

void onGamePlayerStats ( int code , const std::string & errorOrJson ) {

callback for gamePlayerStatsRequest

void onGameSummary ( int code , const std::string & errorOrJson ) {

callback for gameSummaryRequest

void onAdClose ( int code , const std::string & errorOrJson ) {

void onAdFail ( int code , const std::string & errorOrJson ) {

void onAdLeave ( int code , const std::string & errorOrJson ) {

void onAdOpen ( int code , const std::string & errorOrJson ) {

void onAdLoad ( int code , const std::string & errorOrJson ) {

void onAdClick ( int code , const std::string & errorOrJson ) {

void onAdImpression ( int code , const std::string & errorOrJson ) {

void onAdReward ( int code , const std::string & errorOrJson ) {

Manual Integration

If the SDKBOX Installer fails to complete successfully, it is possible to integrate SDKBOX manually. If the installer complete successfully, please do not complete anymore of this document. It is not necessary.

These steps are listed last in this document on purpose as they are seldom needed. If you find yourself using these steps, please, after completing, double back and re-read the steps above for other integration items.

Manual Integration For iOS

Drag and drop the following frameworks from the plugins/ios folder of the HMS bundle into your Xcode project, check Copy items if needed when adding frameworks:

sdkbox.framework

PluginHMS.framework

The above frameworks depend upon other frameworks. You also need to add the following system frameworks, if you don't already have them:

SystemConfiguration.framework

Manual Integration For Android

SDKBOX supports three different kinds of Android projects command-line, eclipse and Android Studio.

• proj.android will be used as our <project_root> for command-line and eclipse project
• proj.android-studio will be used as our <project_root> for Android Studio project.

Copy Files

Copy jar files

Copy the following jar files from plugin/android/libs folder of this bundle into your project's /libs folder.

PluginHMS.jar

sdkbox.jar

• If you're using cocos2d-x from source copy the jar files to:

  Android command-line: cocos2d/cocos/platform/android/java/libs

  Android Studio:

  cocos2d/cocos/platform/android/java/libs
  cocos2d/cocos/platform/android/libcocos2dx/libs
  

• If you're using cocos2d-js or lua copy the jar files to:

  Android command-line: frameworks/cocos2d-x/cocos/platform/android/java/libs

  Android Studio:

  frameworks/cocos2d-x/cocos/platform/android/java/libs
  frameworks/cocos2d-x/cocos/platform/android/libcocos2dx/libs
  

• If you're using prebuilt cocos2d-x copy the jar files to:

  Android command-line: proj.android/libs

Copy jni libs

Copy and overwrite all the folders from plugin/android/jni to your <project_root>/jni/ directory.

Edit build.gradle

your modification maybe look like following:

project root gradle file

buildscript {
    repositories {
        google()
        jcenter()
        maven { url 'https://developer.huawei.com/repo/' } // for hms
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.1'
        classpath 'com.huawei.agconnect:agcp:1.2.1.301' // for hms
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://developer.huawei.com/repo/' } // for hms
    }
}

application's build.gradle

apply plugin: 'com.android.application'
apply plugin: 'com.huawei.agconnect' // for hms

...

dependencies {
    ...
    implementation 'com.huawei.hms:base:4.0.4.301' // for hms
    implementation 'com.huawei.hms:hwid:4.0.4.300' // for hms
    implementation 'com.huawei.hms:iap:4.0.2.300' // for hms
    implementation 'com.huawei.hms:game:4.0.3.301' // for hms
}

Edit AndroidManifest.xml

Include the following permissions above the application tag:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="com.android.vending.BILLING"/>

Edit Android.mk

Edit <project_root>/jni/Android.mk to:

Add additional dependencies to LOCAL_WHOLE_STATIC_LIBRARIES:

LOCAL_WHOLE_STATIC_LIBRARIES += PluginHMS
LOCAL_WHOLE_STATIC_LIBRARIES += sdkbox

Add a call to:

$(call import-add-path,$(LOCAL_PATH))

before any import-module statements.

Add additional import-module statements at the end:

$(call import-module, ./sdkbox)
$(call import-module, ./pluginhms)

This means that your ordering should look similar to this:

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginhms)

Note: It is important to make sure these statements are above the existing $(call import-module,./prebuilt-mk) statement, if you are using the pre-built libraries.

Modify Application.mk (Cocos2d-x v3.0 - v3.2 only)

Edit <project_root>/jni/Application.mk to make sure APP_STL is defined correctly. If Application.mk contains APP_STL := c++_static, it should be changed to:

APP_STL := gnustl_static

Modify AppActivity.java

Plugin >= 2.4.0.3

1. Find the AppActivity.java

find . -name "AppActivity.java"

1. Replace extends Cocos2dxActivity with extends com.sdkbox.plugin.SDKBoxActivity

Example of the directory where the AppActivity.java file is located:

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

Plugin < 2.4.0.3

• If you're using cocos2d-x from source, assuming you are in the proj.android directory, Cocos2dxActivity.java is located:

  ../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/ lib/Cocos2dxActivity.java

• If you're using the prebuilt cocos2d-x libraries assuming you are in the proj.android directory, Cocos2dxActivity.java is located:

  ./src/org/cocos2dx/lib/Cocos2dxActivity.java

Note: When using Cocos2d-x from source, different versions have Cocos2dxActivity.java in a different location. One way to find the location is to look in proj.android/project.properties. Example: android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

In this case, Cocos2dxActivity.java should be located at:

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java

• Modify Cocos2dxActivity.java to add the following imports:

import android.content.Intent;
import com.sdkbox.plugin.SDKBox;

• Second, modify Cocos2dxActivity.java to edit the onCreate(final Bundle savedInstanceState) function to add a call to SDKBox.init(this);. The placement of this call is important. It must be done after the call to onLoadNativeLibraries();. Example:

onLoadNativeLibraries();
SDKBox.init(this);

• Last, we need to insert the proper overrides code. There are a few rules here.

  • If the method listed has not been defined, add it.

  • If the method listed has been defined, add the calls to SDKBox in the same existing function.

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }

Proguard (optional)

• Edit project.properties to specify a Proguard configuration file. Example:

proguard.config=proguard.cfg

• proguard.cfg:

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
#   public *;
#}

# cocos2d-x
-keep public class org.cocos2dx.** { *; }
-dontwarn org.cocos2dx.**
-keep public class com.chukong.** { *; }
-dontwarn com.chukong.**

# HMS
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
-keep class com.hianalytics.android.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}

#sdkbox
-keep public class com.sdkbox.** { *; }
-dontwarn com.sdkbox.**

Note: Proguard only works with Release builds (i.e cocos run -m release) debug builds do not invoke Proguard rules.