FOnlineMessagePayload

Message payload that stores key value pairs for variant type data

Windows
MacOS
Linux

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

Name Description

Public function

FOnlineMessagePayload()

Constructor

Functions

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

 

ToJsonStr()

Convert key/val properties to json str

Constants

Name

Description

MaxPayloadSize

Max size of buffer when serializing payloads

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss