Stream Chat Unreal SDK
Loading...
Searching...
No Matches
JSON

This module contains helper functionality for serializing and deserializing JSON data to and from USTRUCTs using UPROPERTYs. More...

Namespaces

namespace  JsonObjectDeserialization
 Handles converting Json objects to UStructs.
 
namespace  JsonObjectSerialization
 Handles converting UStructs to Json objects.
 
namespace  JsonObject
 Conversion to and from dynamic JSON objects.
 
namespace  JsonField
 Custom serialization and deserialization for types which aren't supported by UPROPERTY (e.g. TOptional)
 

Typedefs

using FJsonAttributeKey = FJsonObject::FStringType
 The key type used by FJsonObject for its attributes.
 
using FJsonAttributeMap = TMap<FJsonAttributeKey, TSharedPtr<FJsonValue>>
 The attributes of a json object, as stored in FJsonObject::Values.
 

Detailed Description

This module contains helper functionality for serializing and deserializing JSON data to and from USTRUCTs using UPROPERTYs.

Note
You should use the "Transient" UPROPERTY-specifier to skip Serialization while still performing Deserialization.

Typedef Documentation

◆ FJsonAttributeKey

using FJsonAttributeKey = FJsonObject::FStringType

The key type used by FJsonObject for its attributes.

UE 5.8 changed these keys from FString to UE::FSharedString, so that keys recurring throughout a json structure can share a single allocation. Aliasing the type here keeps the rest of the module free of engine version checks.

Note that a key is not an FString on every engine, so it has no FString member functions. Wrap it in MakeStringView() to compare or search it, which works for both underlying types.