1. Epic GamesDeveloper
  3. FOnlineMessagePayload

FOnlineMessagePayload

Message payload that stores key value pairs for variant type data

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineMessageInterface.h
Include #include "Interfaces/OnlineMessageInterface.h"

Syntax

class FOnlineMessagePayload

Remarks

Message payload that stores key value pairs for variant type data

Constructors

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function void

FromBytes ( const TArray< uint8 >& InBytes
)

 Convert byte array to key value data
Public function void

FromJson ( const FJsonObject& JsonObject
)

 Convert json to key/val properties
Public function void

FromJsonStr ( const FString& JsonStr
)

 Convert json string to key/val properties
Public function Const bool

GetAttribute ( const FString& AttrName,
FVariantData& OutAttrValue
)

 Find an attribute by name and get its value
Public function void

SetAttribute ( const FString& AttrName,
const FVariantData& AttrValue
)

 Set an attribute value by name
Public function Const void

ToBytes ( TArray< uint8 >& OutBytes
)

 Convert the key value data to byte array
Public function Const void

ToJson ( FJsonObject& OutJsonObject
)

 Convert key/val properties to json
Public function Const FString Convert key/val properties to json str

Constants

Name Description
MaxPayloadSize Max size of buffer when serializing payloads

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page