FOperatingSystemNotification Struct Reference

A struct representing an operating system notification. More...

#include "OperatingSystemNotification.h"

Public Member Functions
FORCEINLINE bool	IsValid () const
FORCEINLINE bool	IsWarning () const
FORCEINLINE bool	IsError () const
	FOperatingSystemNotification ()
	FOperatingSystemNotification (const FText &Title, const EOperatingSystemNotificationCategory &Category)
	Constructs a new operating system notification with the given title and category. The constructor initializes the operating system notification object with the provided title, an empty description, an empty code, the current date and time as the timestamp, a null icon, an operating system notification type of Info, and the given category.
	FOperatingSystemNotification (const FText &Title, const EOperatingSystemNotificationCategory &Category, const EOperatingSystemNotificationType &Verbosity)
	Constructs a new operating system notification with the given title, category, and verbosity level. The constructor initializes the operating system notification object with the provided title, an empty description, an empty code, the current date and time as the timestamp, a null icon, the specified verbosity level, and the given category.
	FOperatingSystemNotification (const FText &Title, const FText &Description, const EOperatingSystemNotificationCategory &Category)
	Constructs a new operating system notification with the given title, description, and category. The constructor initializes the operating system notification object with the provided title, description, an empty code, the current date and time as the timestamp, a null icon, an operating system notification type of Info, and the given category.
	FOperatingSystemNotification (const FText &Title, const FText &Description, const FText &Code, const EOperatingSystemNotificationCategory &Category)
	Constructs a new operating system notification.

Public Attributes
FText	Title
FText	Description
FText	Code
FText	TimeStamp
TSoftObjectPtr< UObject >	Icon
EOperatingSystemNotificationType	Level
EOperatingSystemNotificationCategory	Category

Detailed Description

A struct representing an operating system notification.

This struct encapsulates information about an operating system notification, including its title, description, code, timestamp, icon, level, and category. It provides various constructors to create different types of notifications. Notifications can be checked for validity and can also be checked if they are warnings or errors.

See also

EOperatingSystemNotificationType

EOperatingSystemNotificationCategory

Constructor & Destructor Documentation

FOperatingSystemNotification() [1/5]

FOperatingSystemNotification::FOperatingSystemNotification ( )

inline

FOperatingSystemNotification() [2/5]

FOperatingSystemNotification::FOperatingSystemNotification ( const FText & Title, const EOperatingSystemNotificationCategory & Category )

inline

Constructs a new operating system notification with the given title and category. The constructor initializes the operating system notification object with the provided title, an empty description, an empty code, the current date and time as the timestamp, a null icon, an operating system notification type of Info, and the given category.

Parameters

Title	The title for the notification.
Category	The category of the notification.

Example usage:

FOperatingSystemNotification Notification(FText::FromString("Title"), EOperatingSystemNotificationCategory::OperatingSystem);

FOperatingSystemNotification() [3/5]

FOperatingSystemNotification::FOperatingSystemNotification ( const FText & Title, const EOperatingSystemNotificationCategory & Category, const EOperatingSystemNotificationType & Verbosity )

inline

Constructs a new operating system notification with the given title, category, and verbosity level. The constructor initializes the operating system notification object with the provided title, an empty description, an empty code, the current date and time as the timestamp, a null icon, the specified verbosity level, and the given category.

Parameters

Title	The title for the notification.
Category	The category of the notification.
Verbosity	The verbosity level of the notification.

Example usage:

FOperatingSystemNotification Notification(FText::FromString("Title"), EOperatingSystemNotificationCategory::OperatingSystem, EOperatingSystemNotificationType::Info);

FOperatingSystemNotification() [4/5]

FOperatingSystemNotification::FOperatingSystemNotification ( const FText & Title, const FText & Description, const EOperatingSystemNotificationCategory & Category )

inline

Constructs a new operating system notification with the given title, description, and category. The constructor initializes the operating system notification object with the provided title, description, an empty code, the current date and time as the timestamp, a null icon, an operating system notification type of Info, and the given category.

Parameters

Title	The title for the notification.
Description	A short description of this notification.
Category	The category of the notification.

Example usage:

FText Title = FText::FromString("Title");
FText Description = FText::FromString("Description");
EOperatingSystemNotificationCategory Category = EOperatingSystemNotificationCategory::OperatingSystem;
FOperatingSystemNotification Notification(Title, Description, Category);

FOperatingSystemNotification() [5/5]

FOperatingSystemNotification::FOperatingSystemNotification ( const FText & Title, const FText & Description, const FText & Code, const EOperatingSystemNotificationCategory & Category )

inline

Constructs a new operating system notification.

The constructor initializes the operating system notification object with the provided title, description, code, the current date and time as the timestamp, a null icon, an operating system notification type of Info, and the given category.

Parameters

Title	The title for the notification.
Description	A short description of this notification.
Code	A code like ERR_SOMETHING, ACCESS_DENIED, 0x000FFFD456D, or anything like that.
Category	The category of the notification.

Example usage: FText title = FText::FromString("Title"); FText description = FText::FromString("Description"); FText code = FText::FromString("ERR_SOMETHING"); EOperatingSystemNotificationCategory category = EOperatingSystemNotificationCategory::OperatingSystem; FOperatingSystemNotification notification(title, description, code, category);

Member Function Documentation

IsError()

FORCEINLINE bool FOperatingSystemNotification::IsError ( ) const

inline

Here is the caller graph for this function:

IsValid()

FORCEINLINE bool FOperatingSystemNotification::IsValid ( ) const

inline

Checks if the operating system notification is valid.

A notification is considered valid if:

• The title is not empty or whitespace.
• The level is not None.
• The category is not None.
• The timestamp can be parsed to a valid date and time.

Returns

True if the notification is valid, false otherwise.

Here is the caller graph for this function:

IsWarning()

FORCEINLINE bool FOperatingSystemNotification::IsWarning ( ) const

inline

Here is the caller graph for this function:

Member Data Documentation

Category

EOperatingSystemNotificationCategory FOperatingSystemNotification::Category

What generated this notification?

Code

FText FOperatingSystemNotification::Code

A code like ERR_SOMETHING, ACCESS_DENIED, 0x000FFFD456D or anything like that.

Description

FText FOperatingSystemNotification::Description

A short description of this notification. Typically less than 255 characters but recommended to keep it under 100 characters..

Icon

TSoftObjectPtr<UObject> FOperatingSystemNotification::Icon

An optional icon.

Level

EOperatingSystemNotificationType FOperatingSystemNotification::Level

What type of notification is this?

TimeStamp

FText FOperatingSystemNotification::TimeStamp

Local date and time on this computer. This will be according to your computer's time zone and daylight saving settings.

Title

FText FOperatingSystemNotification::Title

A title for the notification. Something that makes sense.

---

The documentation for this struct was generated from the following file:

• Source/OperatingSystemSimulator/Public/OperatingSystemNotification.h