Preconditions

You have completed access configuration by the instructions for accessing the msdk unity configuration module.

Check if mobile QQ and WeChat are installed

1 Summary

Check if mobile QQ and WeChat are installed

2 Registration callback

None

3 Interface calling

1)Function description

Check if mobile QQ and WeChat are installed. The detailed explanation of the interface is as follows

2)Interface declaration

bool WGIsPlatformInstalled(ePlatform platformType);

3)Parameter description

4)Return value

5)Demo code

bool installed = WGPlatform.Instance.WGIsPlatformInstalled(ePlatform.ePlatform_QQ);

Get mobile QQ or WeChat versions

1 Summary

Get mobile QQ or WeChat versions

2 Registration callback

None

3 Interface calling

1)Function description

Now, only Android supports the function of getting the version of mobile QQ or WeChat. The detailed description of the interface is as follows

2)Interface declaration

string WGGetPlatformAPPVersion(ePlatform platform);

3)Parameter description

4)Return value

5)Demo code

string version = WGPlatform.Instance.WGGetPlatformAPPVersion(ePlatform.ePlatform_QQ);

Check whether or not the interfaces support it

1 Summary

Check if the current mobile QQ or WeChat version supports certain API

2 Registration callback

None

3 Interface calling

1)Function description

Some API can be used only in new versions of mobile QQ or WeChat. Call WGCheckApiSupport interface to check if the current mobile QQ or WeChat version supports certain API. The detailed description of the interface is as follows:

2)Interface declaration

bool WGCheckApiSupport(eApiName apiName);

3)Parameter description

4)Return value

5)Demo code

bool isSupport = WGPlatform.Instance.WGCheckApiSupport((eApiName)api);

Get MSDK version

1 Summary

Get MSDK version

2 Registration callback

None

3 Interface calling

1)Function description

Call WGGetVersion interface to get MSDK's version. The detailed description of the interface is as follows

2)Interface declaration

string WGGetVersion();

3)Parameter description

None

4)Return value

5)Demo code

string version = WGPlatform.Instance.WGGetVersion()

Get the installation channel

1 Summary

Get the installation channel
Remarks: After the interface for getting the installation channel number is accessed, when verifying whether the interface can work normally, you shall choose the real machine to verify it. If you use Tencent mobile game assistant simulator to verify it, please do not directly locally install apk to Tencent mobile game assistant simulator, because Tencent mobile game assistant simulator will mandatorily change the channel number of the locally installed apk to 100048 (the original channel number is less than 6 digits) or 10004822

2 Registration callback

None

3 Interface calling

1)Function description

Installation channel: before a game goes online, it is packed into apk packages with different channel numbers according to the channel name (such as MyApp, Wandoujia, 91 Mobile Assistant, etc.). The channel number in an apk package is called installation channel.

Calling WGGetChannelId can get a game's installation channel. The detailed description of the interface is as follows

2)Interface declaration

string WGGetChannelId();

3)Parameter description

None

4)Return value

5)Demo code

string channelId = WGPlatform.Instance.WGGetChannelId();

6)Special description

None

7)Name interpretation

Installation channel: before a game goes online, it is packed into apk packages with different channel numbers according to the channel name (such as MyApp, Wandoujia, 91 Mobile Assistant, etc.). The channel number in an apk package is called installation channel.

Get the registration channel

1 Summary

Get the registration channel

2 Registration callback

None

3 Interface calling

1)Function description

Registration channel: the installation channel through which the user logs into WeChat or mobile QQ for the first time. The value is bound with the account and can't be changed.

Calling WGGetRegisterChannelId can return the user's registration channel. The detailed description of the interface is as follows

2)Interface declaration

string WGGetRegisterChannelId();

3)Parameter type

None

4)Return value type

5)Demo code

string registerChannelId = WGPlatform.Instance.WGGetRegisterChannelId();

6)Special description

None

7)Name interpretation

Registration channel: the installation channel through which the user logs into WeChat or mobile QQ for the first time. The value is bound with the account and can't be changed.

User feedback

1 Summary

User feedback: User feedbacks can be made through this event interface.

2 Registration callback

None

3 Interface calling

1)Function description

User feedback: User feedbacks can be made through this event interface, and feedback content is shown at http://dev.ied.com/msdk/userfeedback/index (access through the Intranet, and the Tencent operation interface administrator may assist you in your search). The interface required for the function is: WGFeedback. The detailed description of the interface is as follows:

2)Interface declaration

void WGFeedback(string body);

3)Parameter description

4)Return value

None

5)Demo code

WGPlatform.Instance.WGFeedback("the user experience is made to the extreme");

Deeplink link skip

1 Summary

Deeplink link skip

2 Registration callback

None

3 Interface calling

1)Function description

Deeplink can support skipping to WeChat game center's native pages and activity pages. The specific presentation scheme and display entrance can be customized according to the game's actual situation. The game center's native pages include: WeChat game center's homepage, WeChat game center's details page, WeChat game center's game library, etc.. They are implemented through the game's backend parameter settings. Activity pages include: the game's H5 page. They are implemented through the game's backend setting the skip site

2)Interface declaration

public static void WGOpenWeiXinDeeplink(string link);

3)Parameter description

4)Return value

None

5)Demo code

WGPlatform.Instance.WGOpenWeiXinDeeplink("INDEX");

The third party APP Launch Privilege

1 Summary description

The third party APP Launch Privilege allows the user to launch a game in the third party APP and pass data to the game.It is used for the cooperation of the third party APP and games. For example, users who start games from Tencent videos can get scores, experience bonus and so on.

2 Registration callback

1) You have already registered your game at Tencent open platform and passed the review, or your Tencent contact person has registered your game through internal channels.

2) You have completed Access Configuration by following the instructions for accessing the configuration module.

3) Android：You need to modify AndroidManifest.xml and add the corresponding configuration items to it, and replace qqappid with your application's qqappid.

ios：You need to modify the plist to add the corresponding URL Types configuration items to it ,and replace qqappid with your application's qqappid.

Remarks: Note that the new and old versions are different in configuration. As for the specific configurations, please refer to the following notes. The old version’s configuration starts to be supported since 3.2.5, and the new version’s configuration is supported by 3.2.8 and higher versions

<!-- Android third-party APP launch configuration -->
<activity
    android:name="com.tencent.msdk.SchemeActivity"
    android:launchMode="singleTask">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- 3.2.8a and higher versions set tencentmsdk+qqappid here; 3.2.5a~3.2.7a version sets tencentvideo+qqappid here-->
        <data android:scheme="tencentmsdk100703379" />
    </intent-filter>
</activity>

<!-- ios third-party APP launch configuration -->
//3.2.5i~3.2.7i versions are configured as follows:
Identifier:tencentvideo
URL Schemes:tencentlaunch100703379
Role:Editor

//3.2.8i versions and above are configured as follows:
Identifier:tencentmsdk
URL Schemes:tencentmsdk100703379
Role:Editor

4) Need to implement OnWakeupNotify callback function

When the third party app launches the game, it will inform the game of the parameters and other information which the started platform needs to pass through WGPlatformObserver's OnWakeupNotify (WakeupRet), where WakeupRet.platform represents the platform which launches the game. For example, at this time, WakeupRet.platform is EWakeupPlatform. eWakeupPlatform_TencentMsdk（3.2.5~3.2.7 versions is EWakeupPlatform.eWakeupPlatform_TencentVideo）; WakeupRet.extInfo is Vector type and carries the data passed by the platform.

3)Interface call

None

4)Return value

None

5)Demo code

virtual void OnWakeupNotify(WakeupRet &wakeupRet)
    {
        LOGD("OnWakeupNotify: platform:%d flag:%d openid:%s", wakeupRet.platform, wakeupRet.flag,
            wakeupRet.open_id.c_str());wakeupRet.extInfo
        // TODO GAME The game needs to add the logic to handle account inconsistency here
        switch (wakeupRet.flag)
        {
            case eFlag_Succ:
                if(wakeupRet.platform == eWakeupPlatform_TencentMsdk)//3.2.5~3.2.7 versions is eWakeupPlatform_TencentVideo
            {
                    jstring j_msg_title = mEnv->NewStringUTF("by the MSDK Scheme launche");
                    std::string c_extinfo;
                    for(int i =0;i<wakeupRet.extInfo.size();i++){
                        c_extinfo = c_extinfo + wakeupRet.extInfo[i].key + ":" + wakeupRet.extInfo[i].value + "\n";
                    }
                    jstring j_msg_msg = mEnv->NewStringUTF(c_extinfo.c_str());
                    jclass cls = mEnv->GetObjectClass(gActivity);
                    jmethodID methodShowTips = mEnv->GetMethodID(cls, "showTipsDialog", "(Ljava/lang/String;Ljava/lang/String;)V");
                    mEnv->CallVoidMethod(gActivity, methodShowTips, j_msg_title, j_msg_msg);
                    mEnv->DeleteLocalRef(j_msg_title);
                    mEnv->DeleteLocalRef(j_msg_msg);
                }
                std::string platformdata;
                std::string gamedata;
                for(int i = 0;i < wakeupRet.extInfo.size();i++){
                    if(wakeupRet.extInfo[i].key.compare("platformdata"))
                    {
                        platformdata = wakeupRet.extInfo[i].value;
                        LOGD("OnwakeupNotify: platformdata:%s",platformdata);
                    }
                    if(wakeupRet.extInfo[i].key.compare("gamedata"))
                    {
                        gamedata = wakeupRet.extInfo[i].value;
                        LOGD("OnwakeupNotify: gamedata:%s",gamedata);
                    }
                }

            default:
            {
                // default no processing
                LOGD("login%s", "");
                jclass cls = mEnv->GetObjectClass(gActivity);
                jmethodID methodletUserLogout = mEnv->GetMethodID(cls, "letUserLogout", "()V");
                mEnv->CallVoidMethod(gActivity, methodletUserLogout);
                LOGD("OnWakeupNotify call letUserLogout end%s", "");
                break;
            }
        }
    }

Launch WeChat business, and share the message to WeChat Games (Haowan)

1)Function description

Provide functions to third parties, such as notifying WeChat to launch the internal browser, sharing messages to WeChat Games (Haowan), and opening the webpage or miniApp of the designated business. The interface has been added since version 3.3.6.

2)Interface declaration

    void WGSendToWXWithOpenBusinessView(const unsigned char *businessType,
                                        const unsigned char *query,
                                        const unsigned char *extInfo,
                                        const unsigned char *extData);

3)Parameter description

4)Return value

None

5)Demo code

    //Android Local video
    WGPlatform::GetInstance()->WGSendToWXWithOpenBusinessView("nativeShareToGameHaoWan", "", "{\"videoPath\":\"/storage/emulated/0/test_video.mp4\", \"needEdit\":1, \"gameInfo\":{\"battleId\":\"game12345\",\"appid\":\"YOUR_WECAHT_APPID\",\"appName\":\"MSDKDemo\"}}", "");

    //iOS Local video
    WGPlatform::GetInstance()->WGSendToWXWithOpenBusinessView((unsigned char*)"nativeShareToGameHaoWan", (unsigned char*)"", (unsigned char*)"{\"thumbUrl\":\"http://shp.qpic.cn/record_smoba/0/53209e869e71dc351129059fbb5f748dT1552892652598430/\" , \"needEdit\":1, \"gameInfo\":{\"battleId\":\"game12345\",\"appid\":\"YOUR_WECAHT_APPID\",\"appName\":\"MSDKDemo\"}}", (unsigned char*)[testVideoPath UTF8String]);

    //Cloud video
    WGPlatform::GetInstance()->WGSendToWXWithOpenBusinessView((unsigned char*)"nativeShareToGameHaoWan", (unsigned char*)"", (unsigned char*)"{\"videoUrl\":\"https://qt.qq.com/php_cgi/cod_video/php/get_video_url.php?vid=2a495e10fc03426fb8e4def77fc68a57&game_id=1007039\", \"thumbUrl\":\"http://shp.qpic.cn/record_smoba/0/53209e869e71dc351129059fbb5f748dT1552892652598430/\" , \"needEdit\":1, \"gameInfo\":{\"battleId\":\"game12345\",\"appid\":\"YOUR_WECAHT_APPID\",\"appName\":\"MSDKDemo\"}}", (unsigned char*)"");

Get country information based on IP address

1)Function description

Get country information based on IP address. Version 3.3.7 began to add this interface. In order to receive the callback, you need to register WGPlatformObserver and handle it via OnLocationGotCountryFromIPNotify.

2)Interface declaration

    void WGGetCountryFromIP();

3)Parameter description

None

4)Return value

None. The sharing result is called back via WGPlatformObserver OnLocationGotCountryFromIPNotify function returns to the game.

5)Demo code

    //Callback function
    WGPlatformObserver::OnLocationGotCountryFromIPNotify(GetCountryFromIPRet& fromIPRet);
    //Interface example