Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Notification object, used to send messages between systems
| Name | FOnlineNotification |
| Type | struct |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineNotification.h |
| Include Path | #include "OnlineNotification.h" |
Syntax
struct FOnlineNotification
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor | OnlineNotification.h | ||
FOnlineNotification
(
const FString& InTypeStr, |
Constructor from type and FJsonValue System message unless ToUserId is specified; FromUserId optional | OnlineNotification.h | |
FOnlineNotification
(
const FString& InTypeStr, |
Constructor from type and FJsonObject System message unless ToUserId is specified; FromUserId optional | OnlineNotification.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClientRequestIdStr | FString | String representing the client_request_id for this notification. | OnlineNotification.h | |
| FromUserId | FUniqueNetIdPtr | User who sent the notification, optional. | OnlineNotification.h | |
| Payload | TSharedPtr< FJsonObject > | The payload of this notification | OnlineNotification.h | |
| ToUserId | FUniqueNetIdPtr | User to deliver the notification to. Can be null for system notifications. | OnlineNotification.h | |
| TypeStr | FString | A string defining the type of this notification, used to determine how to parse the payload | OnlineNotification.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ParsePayload
(
FStruct& PayloadOut |
Parse a payload and assume there is a static const TypeStr member to use | OnlineNotification.h | |
bool ParsePayload
(
UStruct* StructType, |
Parse out Payload into the provided UStruct | OnlineNotification.h | |
void SetClientRequestIdFromPayload() |
Set up the ClientRequestIdStr for the case where it is embedded in the payload | OnlineNotification.h | |
void SetTypeFromPayload() |
Set up the type string for the case where the type is embedded in the payload | OnlineNotification.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Does this notification have a valid payload? | OnlineNotification.h |