Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
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
| Type | Name | Description | |
|---|---|---|---|
 |
FString | ClientRequestIdStr | String representing the client_request_id for this notification. |
 |
FUniqueNetIdPtr | FromUserId | User who sent the notification, optional. |
 |
TSharedPtr< FJsonObject > | Payload | The payload of this notification |
 |
FUniqueNetIdPtr | 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
| Type | Name | Description | |
|---|---|---|---|
 |
Default constructor | ||
 |
FOnlineNotification
(
const FString& InTypeStr, |
Constructor from type and FJsonValue System message unless ToUserId is specified; FromUserId optional | |
 |
FOnlineNotification
(
const FString& InTypeStr, |
Constructor from type and FJsonObject System message unless ToUserId is specified; FromUserId optional |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | ParsePayload
(
FStruct& PayloadOut |
Parse a payload and assume there is a static const TypeStr member to use |
  |
bool | ParsePayload
(
UStruct* StructType, |
Parse out Payload into the provided UStruct |
 |
void | Set up the ClientRequestIdStr for the case where it is embedded in the payload | |
 |
void | Set up the type string for the case where the type is embedded in the payload |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
Does this notification have a valid payload? |