Obtain InstanceID (GetInstanceIDAsync)

caution

[MSDK only] The GetInstanceID API mentioned in this section is deprecated starting from MSDKV5.16. Please use getInstanceIDAsync to obtain the InstanceID.

[Player Network SDK & MSDK] The Firebase channel obtains the Firebase InstanceID.

Firebase Instance ID provides a unique identifier for each installation of an app.The Instance ID will change in the following situations:

1. The app calls deleteInstanceId API to erase Instance ID.
2. User uninstalls/reinstalls the app
3. User deletes app data

Supported channel: Firebase

Supported platforms

Unity

Supports Android, iOS platform.

Unreal Engine

Supports Android, iOS platform.

Function Definition

Unity

string GetInstanceID(string channel);

Unreal Engine

static std::string GetInstanceID(const std::string &channel);

Input Parameters

Unity

Parameters	Type	Description
channel	string	Channel definition

Unreal Engine

Parameters	Type	Description
channel	std::string	Channel definition

Code Example

Unity

UnionAdapterAPI.GetReportService().GetInstanceID("Firebase");

Unreal Engine

GUA_NAMESPACE::GUAReportService::GetInstanceID("Firebase");

getInstanceIDAsync code example

Unity

// Set Extend callback
UnionAdapterAPI.GetExtendService().ExtendRetEvents += mLoginCallBack.OnExtendRetEvent;

// Call getInstanceIDAsync
UnionAdapterAPI.GetExtendService().Invoke ("Firebase", "getInstanceIDAsync", "");

// Get result in callback, the result is in extendRet.extraJson, JSON format as follows: {"instanceID":"xxxxxxx"}
public void OnExtendRetEvent (GUAExtendResult extendRet)
{
    string methodTag = extendRet.extendMethodName;

    mCurrentTestMgr.ShowLogInNewLine (methodTag + extendRet);
}

Unreal Engine

// Set Extend callback
GUA_NAMESPACE::GUAExtendService::SetExtendObserver(mGUAExtendCallBacks);

// Call getInstanceIDAsync
GUA_NAMESPACE::GetExtendService::Invoke("Firebase", "getInstanceIDAsync", "");

// Get result in callback, the result is in extendRet.extraJson, JSON format as follows: {"instanceID":"xxxxxxx"}
class MyExtendObserver : public GUA_NAMESPACE::GUAExtendObserver {
public:
    void OnExtendNotify(const GUAExtendResult &extendRet) {
        handleCallback(extendRet, extendRet.method_id);
    };
};