GetFreeFlowInfo [MSDK Only]
[MSDK Only] The game client calls the backend API to verify for free data service.
The client pass the key parameter, which is the game IP, to the backend. If the player qualify for free data service, the server will send the corresponding VIP to the client.
Supported Platform
- Unity
- Unreal Engine
Supports
Android, iOS platform.Supports
Android, iOS platform.Function Definition
- Unity
- Unreal Engine
bool GetFreeFlowInfo(string key, string extra = "");
static bool GetFreeFlowInfo(std::string key, std::string extraJson="{}");
Input Parameters
- Unity
- Unreal Engine
| Parameter | Type | Description |
|---|---|---|
| key | string | key is returned according to the key (original IP), and the corresponding value (corresponding svip) of the background streaming free configuration |
| extraJson | string | Extended field, currently not in use |
| Parameter | Type | Description |
|---|---|---|
| key | std::string | key is returned according to the key (original IP), and the corresponding value (corresponding svip) of the background streaming free configuration |
| extraJson | std::string | Extended field, currently not in use |
Callback Processing
The callback processing API is GUAToolsFreeFlowResultObserver. The callback data structure is GUAToolsFreeFlowResult.
- Unity
- Unreal Engine
The callback methodID is GUA_TOOLS_FREE_FLOW.
The callback methodID is kMethodIDToolsFreeFlow.
Code Sample
- Unity
- Unreal Engine
UnionAdapterAPI.GetToolsService().GetFreeFlowInfo();
GUA_NAMESPACE::GetToolsService::GetFreeFlowInfo();