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

Supports Android, iOS platform.

Unreal Engine

Supports Android, iOS platform.

Function Definition

Unity

bool GetFreeFlowInfo(string key,  string extra = "");

Unreal Engine

static bool GetFreeFlowInfo(std::string key,  std::string extraJson="{}");

Input Parameters

Unity

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

Unreal Engine

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

The callback methodID is GUA_TOOLS_FREE_FLOW.

Unreal Engine

The callback methodID is kMethodIDToolsFreeFlow.

Code Sample

Unity

UnionAdapterAPI.GetToolsService().GetFreeFlowInfo();

Unreal Engine

GUA_NAMESPACE::GetToolsService::GetFreeFlowInfo();