Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FOnlineNotification

Notification object, used to send messages between systems

Windows

MacOS

Linux

References

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

Syntax

struct FOnlineNotification

Remarks

Notification object, used to send messages between systems

Variables

	Name	Description
TSharedPtr< con...	FromUserId	User who sent the notification, optional.
TSharedPtr< FJs...	Payload	The payload of this notification
TSharedPtr< con...	ToUserId	User to deliver the notification to. Can be null for system notifications.
FString	TypeStr	A string defining the type of this notification, used to determine how to parse the payload

Constructors

	Name	Description
	FOnlineNotification()	Default constructor
	FOnlineNotification ( const FString& InTypeStr, const TSharedPtr< FJsonValue >& In..., TSharedPtr< const FUniqueNetId > In..., TSharedPtr< const FUniqueNetId > In... )	Constructor from type and FJsonValue System message unless ToUserId is specified; FromUserId optional
	FOnlineNotification ( const FString& InTypeStr, const TSharedPtr< FJsonObject >& I..., TSharedPtr< const FUniqueNetId > In..., TSharedPtr< const FUniqueNetId > In... )	Constructor from type and FJsonObject System message unless ToUserId is specified; FromUserId optional

Functions

	Name	Description
bool	ParsePayload ( FStruct& PayloadOut )	Parse a payload and assume there is a static const TypeStr member to use
bool	ParsePayload ( UStruct* StructType, void* StructPtr )	Parse out Payload into the provided UStruct
void	SetTypeFromPayload()	Set up the type string for the case where the type is embedded in the payload

Operators

		Name	Description
		operator bool()	Does this notification have a valid payload?

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

Take our survey

Dismiss