Skip to main content

Client TitleConfigData API Reference

Title Config Data is a set of key-value pairs for the whole title. It is commonly used to store configuration data that is applicable across the title-wide, such as title region info list, game client version control data, and so on.

API List

APIDescription
GetTitleConfigKVDataQuery the specified key-value data of the title config data.
GetAllTitleConfigKVDataQuery all key-value data of the title config data.

API Details

GetTitleConfigKVData

Query the specified key-value data of the title config data.

/**
* Query the specified key-value data of the title config data.
*
* @param QueryKeys Keys to query
* @param ResultCallback The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.
*/
void GetTitleConfigKVData(
const TArray<FString>& QueryKeys,
TFunction<void(const FPgosResult& Ret, const FPgosTitleConfigKVDataQueryResult* Data)> ResultCallback) const;

Parameters:

ParamTypeDescription
QueryKeysconst TArray<FString>&Keys to query
ResultCallbackTFunction<void(const FPgosResult& Ret, const FPgosTitleConfigKVDataQueryResult* Data)>The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.

Return: void

GetAllTitleConfigKVData

Query all key-value data of the title config data.

/**
* Query all key-value data of the title config data.
*
* @param ResultCallback The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.
*/
void GetAllTitleConfigKVData(
TFunction<void(const FPgosResult& Ret, const FPgosTitleConfigKVDataQueryResult* Data)> ResultCallback) const;

Parameters:

ParamTypeDescription
ResultCallbackTFunction<void(const FPgosResult& Ret, const FPgosTitleConfigKVDataQueryResult* Data)>The result callback after the API execution ends, and it will be called in the GAME THREAD. For lifetime safety, it is recommended to use the CreateWeakCallback provided in PgosSDKCpp.h to create a lambda bound to an UObject.

Return: void