FOperatingSystemNotification

#include <OperatingSystemSimulator/Public/OperatingSystemNotification.h>

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FOperatingSystemNotification["FOperatingSystemNotification"]
  class EOperatingSystemNotificationType["EOperatingSystemNotificationType"]
  FOperatingSystemNotification ..> EOperatingSystemNotificationType
  class EOperatingSystemNotificationCategory["EOperatingSystemNotificationCategory"]
  FOperatingSystemNotification ..> EOperatingSystemNotificationCategory

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FOperatingSystemNotification {
    +Title : FText
    +Description : FText
    +Code : FText
    +TimeStamp : FText
    +Icon : TSoftObjectPtr< UObject >
    +Level : EOperatingSystemNotificationType()
    +Category : EOperatingSystemNotificationCategory()
    +IsValid() const bool
    +IsWarning() const bool
    +IsError() const bool
    +FOperatingSystemNotification()
    +FOperatingSystemNotification(const FText &Title, const EOperatingSystemN
    +FOperatingSystemNotification(const FText &Title, const EOperatingSystemN
    +FOperatingSystemNotification(const FText &Title, const FText &Descriptio
    +FOperatingSystemNotification(const FText &Title, const FText &Descriptio
  }

struct FOperatingSystemNotification

Defined in OperatingSystemNotification.h:58 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

See also: EOperatingSystemNotificationCategory

Public Attributes

Return	Name	Description
FText	Title	A title for the notification. Something that makes sense.
FText	Description	A short description of this notification. Typically less than 255 characters but recommended to keep it under 100 characters..
FText	Code	A code like ERR_SOMETHING, ACCESS_DENIED, 0x000FFFD456D or anything like that.
FText	TimeStamp	Local date and time on this computer. This will be according to your computer’s time zone and daylight saving settings.
TSoftObjectPtr< UObject >	Icon	An optional icon.
EOperatingSystemNotificationType	Level	What type of notification is this?
EOperatingSystemNotificationCategory	Category	What generated this notification?

---

Title

FText Title

Defined in OperatingSystemNotification.h:64 A title for the notification. Something that makes sense.

---

Description

FText Description

Defined in OperatingSystemNotification.h:68 A short description of this notification. Typically less than 255 characters but recommended to keep it under 100 characters..

---

Code

FText Code

Defined in OperatingSystemNotification.h:72 A code like ERR_SOMETHING, ACCESS_DENIED, 0x000FFFD456D or anything like that.

---

TimeStamp

FText TimeStamp

Defined in OperatingSystemNotification.h:76 Local date and time on this computer. This will be according to your computer’s time zone and daylight saving settings.

---

Icon

TSoftObjectPtr< UObject > Icon

Defined in OperatingSystemNotification.h:80 An optional icon.

Referenced by

• CreateNotification

---

Level

EOperatingSystemNotificationType Level

Defined in OperatingSystemNotification.h:84 What type of notification is this?

Referenced by

• CreateNotification

---

Category

EOperatingSystemNotificationCategory Category

Defined in OperatingSystemNotification.h:88 What generated this notification?

Public Methods

Return	Name	Description
bool	IsValid const inline	Checks if the operating system notification is valid.
bool	IsWarning const inline
bool	IsError const inline
	FOperatingSystemNotification inline
	FOperatingSystemNotification 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.
	FOperatingSystemNotification 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.
	FOperatingSystemNotification 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.
	FOperatingSystemNotification inline	Constructs a new operating system notification.

---

IsValid

const inline

inline bool IsValid() const

Defined in OperatingSystemNotification.h:101 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.

Referenced by

• IsNotificationValid
• LogNotification

References

• None

---

IsWarning

const inline

inline bool IsWarning() const

Defined in OperatingSystemNotification.h:112

References

• Warning

---

IsError

const inline

inline bool IsError() const

Defined in OperatingSystemNotification.h:113

References

• Error

---

FOperatingSystemNotification

inline

inline FOperatingSystemNotification()

Defined in OperatingSystemNotification.h:115

FOperatingSystemNotification

inline

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

Defined in OperatingSystemNotification.h:139 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

inline

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

Defined in OperatingSystemNotification.h:164 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

inline

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

Defined in OperatingSystemNotification.h:192 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

inline

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

Defined in OperatingSystemNotification.h:221 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);