FOperatingSystemMailSetting
#include <OperatingSystemSimulator/Public/Data/OperatingSystemMailTypes.h>struct FOperatingSystemMailSettingDefined in OperatingSystemMailTypes.h:18
Inherits:
FTableRowBase
Inheritance diagram
Section titled “Inheritance diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemMailSetting["FOperatingSystemMailSetting"]
class FTableRowBase["FTableRowBase"]
FTableRowBase <|-- FOperatingSystemMailSetting
Collaboration diagram
Section titled “Collaboration diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemMailSetting["FOperatingSystemMailSetting"]
class UOperatingSystemWidgetBase["UOperatingSystemWidgetBase"]
FOperatingSystemMailSetting *-- UOperatingSystemWidgetBase
Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemMailSetting {
+SenderName : FText
+Subject : FText
+Content : FText
+ContentWidgetClass : TSoftClassPtr< UOperatingSystemWidgetBas
+Date : FDateTime
+CategoryTag : FGameplayTag
+SenderIcon : TSoftObjectPtr< UObject >
+bIsUnread : uint8
+bIsReply : uint8
+ToEmail : FText
+FromEmail : FText
+AuthorEmail : FText
+LastReplyDate : FDateTime
+IsValid() const bool
+operator==(const FOperatingSystemMailSetting &Other) c bool
+operator<(const FOperatingSystemMailSetting &Other) c bool
+operator>(const FOperatingSystemMailSetting &Other) c bool
+FOperatingSystemMailSetting()
+FOperatingSystemMailSetting(const FText &SenderName, const FText &Subje
+FOperatingSystemMailSetting(const FOperatingSystemMailSetting &Other)
+FOperatingSystemMailSetting(const FOperatingSystemMailSetting &Other, c
+FOperatingSystemMailSetting(const FOperatingSystemMailSetting &Other, c
+IsValidCategoryTag(const FGameplayTag &TargetCategoryTag) bool
}
Caller impact — IsValid
Section titled “Caller impact — IsValid”Documented call sites inside the plugin (6):
flowchart LR FOperatingSystemMailSetting__IsValid["FOperatingSystemMailSetting::IsValid"] UOperatingSystemMailManager__ArchiveEmail["UOperatingSystemMailManager::ArchiveEmail"] UOperatingSystemMailManager__ArchiveEmail --> FOperatingSystemMailSetting__IsValid UOperatingSystemMailManager__ChangeEmailState["UOperatingSystemMailManager::ChangeEmailState"] UOperatingSystemMailManager__ChangeEmailState --> FOperatingSystemMailSetting__IsValid UOperatingSystemMailManager__Internal_SendEmailToUser["UOperatingSystemMailManager::Internal_SendEmailToUser"] UOperatingSystemMailManager__Internal_SendEmailToUser --> FOperatingSystemMailSetting__IsValid UOperatingSystemStatics__IsMailDataValid["UOperatingSystemStatics::IsMailDataValid"] UOperatingSystemStatics__IsMailDataValid --> FOperatingSystemMailSetting__IsValid UOperatingSystemMailManager__ReplyToEmail["UOperatingSystemMailManager::ReplyToEmail"] UOperatingSystemMailManager__ReplyToEmail --> FOperatingSystemMailSetting__IsValid UOperatingSystemMailManager__TrashEmail["UOperatingSystemMailManager::TrashEmail"] UOperatingSystemMailManager__TrashEmail --> FOperatingSystemMailSetting__IsValid
The content widget class for the mail settings.
This variable represents the class of the content widget used in the mail settings. The content widget class is a pointer to a soft class of type UOperatingSystemWidget
Friends
Section titled “Friends”| Name | Description |
|---|---|
GetTypeHash inline |
GetTypeHash
Section titled “GetTypeHash”inline
friend inline uint32 GetTypeHash(const FOperatingSystemMailSetting & Other)Defined in OperatingSystemMailTypes.h:154
Public Attributes
Section titled “Public Attributes”| Return | Name | Description |
|---|---|---|
FText | SenderName | The name of the sender for email correspondence. |
FText | Subject | The subject of the email. |
FText | Content | The content of the mail. |
TSoftClassPtr< UOperatingSystemWidgetBase > | ContentWidgetClass | The content widget class for the mail settings. The content widget class is a pointer to a soft class of type UOperatingSystemWidgetBase. |
FDateTime | Date | Stores the date and time at which this mail was sent in UTC format. |
FGameplayTag | CategoryTag | Represents a gameplay tag for categorizing mail settings. |
TSoftObjectPtr< UObject > | SenderIcon | A simple icon for this email. |
uint8 | bIsUnread | Flag indicating whether a mail is marked as unread. |
uint8 | bIsReply | Flag indicating whether the mail is a reply. |
FText | ToEmail | The email address of the recipient. |
FText | FromEmail | Represents the email address from which a mail is being sent. It holds the email address from which a mail is being sent. |
FText | AuthorEmail | Email address of the person who created this email. |
FDateTime | LastReplyDate | Last reply date variable. |
SenderName
Section titled “SenderName”FText SenderNameDefined in OperatingSystemMailTypes.h:31 The name of the sender for email correspondence.
For example, this variable could be set to “John Doe” to indicate that the sender of the email correspondence is John Doe.
See also: MailSetting
Referenced by
Section titled “Referenced by”Subject
Section titled “Subject”FText SubjectDefined in OperatingSystemMailTypes.h:41 The subject of the email.
The Subject variable holds the subject of the email. It is a user-defined string that represents the subject of the email being composed or received.
Referenced by
Section titled “Referenced by”Content
Section titled “Content”FText ContentDefined in OperatingSystemMailTypes.h:47 The content of the mail.
Referenced by
Section titled “Referenced by”ContentWidgetClass
Section titled “ContentWidgetClass”TSoftClassPtr< UOperatingSystemWidgetBase > ContentWidgetClassDefined in OperatingSystemMailTypes.h:54 The content widget class for the mail settings. The content widget class is a pointer to a soft class of type UOperatingSystemWidgetBase.
Referenced by
Section titled “Referenced by”FDateTime DateDefined in OperatingSystemMailTypes.h:60 Stores the date and time at which this mail was sent in UTC format.
Referenced by
Section titled “Referenced by”CategoryTag
Section titled “CategoryTag”FGameplayTag CategoryTagDefined in OperatingSystemMailTypes.h:69 Represents a gameplay tag for categorizing mail settings.
This class is used to specify the category of a mail setting. It is a gameplay tag, which means it can be used to categorize mail settings based on specific categories.
Referenced by
Section titled “Referenced by”SenderIcon
Section titled “SenderIcon”TSoftObjectPtr< UObject > SenderIconDefined in OperatingSystemMailTypes.h:73 A simple icon for this email.
Referenced by
Section titled “Referenced by”bIsUnread
Section titled “bIsUnread”uint8 bIsUnreadDefined in OperatingSystemMailTypes.h:82 Flag indicating whether a mail is marked as unread.
This variable is a bitflag used to indicate whether a mail is marked as unread. It takes a value of false or true. A value of false means the mail is marked as read, while a value of true means the mail is marked as unread.
Referenced by
Section titled “Referenced by”bIsReply
Section titled “bIsReply”uint8 bIsReplyDefined in OperatingSystemMailTypes.h:93 Flag indicating whether the mail is a reply.
The flag is represented by a uint8 variable that uses only 1 bit of storage, allowing it to have two possible values: 0 or 1. A value of 0 indicates that the mail is not a reply, while a value of 1 indicates that the mail is a reply.
Referenced by
Section titled “Referenced by”ToEmail
Section titled “ToEmail”FText ToEmailDefined in OperatingSystemMailTypes.h:99 The email address of the recipient.
Referenced by
Section titled “Referenced by”FromEmail
Section titled “FromEmail”FText FromEmailDefined in OperatingSystemMailTypes.h:106 Represents the email address from which a mail is being sent. It holds the email address from which a mail is being sent.
Referenced by
Section titled “Referenced by”AuthorEmail
Section titled “AuthorEmail”FText AuthorEmailDefined in OperatingSystemMailTypes.h:112 Email address of the person who created this email.
Referenced by
Section titled “Referenced by”LastReplyDate
Section titled “LastReplyDate”FDateTime LastReplyDateDefined in OperatingSystemMailTypes.h:118 Last reply date variable.
Referenced by
Section titled “Referenced by”Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
bool | IsValid const inline | |
bool | operator== const inline | |
bool | operator< const inline | |
bool | operator> const inline | |
FOperatingSystemMailSetting inline | ||
FOperatingSystemMailSetting inline | FOperatingSystemMailSetting constructor. | |
FOperatingSystemMailSetting inline | FOperatingSystemMailSetting copy constructor. | |
FOperatingSystemMailSetting inline | FOperatingSystemMailSetting copy constructor. | |
FOperatingSystemMailSetting inline | FOperatingSystemMailSetting constructor. |
IsValid
Section titled “IsValid”const inline
inline bool IsValid() constDefined in OperatingSystemMailTypes.h:125
Referenced by
Section titled “Referenced by”operator==
Section titled “operator==”const inline
inline bool operator==(const FOperatingSystemMailSetting & Other) constDefined in OperatingSystemMailTypes.h:132
References
Section titled “References”operator<
Section titled “operator<”const inline
inline bool operator<(const FOperatingSystemMailSetting & Other) constDefined in OperatingSystemMailTypes.h:144
References
Section titled “References”operator>
Section titled “operator>”const inline
inline bool operator>(const FOperatingSystemMailSetting & Other) constDefined in OperatingSystemMailTypes.h:149
References
Section titled “References”FOperatingSystemMailSetting
Section titled “FOperatingSystemMailSetting”inline
inline FOperatingSystemMailSetting()Defined in OperatingSystemMailTypes.h:166
Section titled “Defined in OperatingSystemMailTypes.h:166”FOperatingSystemMailSetting
Section titled “FOperatingSystemMailSetting”inline
inline FOperatingSystemMailSetting(const FText & SenderName, const FText & Subject, const FText & Content)Defined in OperatingSystemMailTypes.h:192 FOperatingSystemMailSetting constructor.
Parameters
Section titled “Parameters”-
SenderNameThe name of the sender for email correspondence. For example, this variable could be set to “John Doe” to indicate that the sender of the email correspondence is John Doe. -
SubjectThe subject of the email. -
ContentThe content of the mail.
FOperatingSystemMailSetting
Section titled “FOperatingSystemMailSetting”inline
inline FOperatingSystemMailSetting(const FOperatingSystemMailSetting & Other)Defined in OperatingSystemMailTypes.h:218 FOperatingSystemMailSetting copy constructor.
This constructor creates a new FOperatingSystemMailSetting object by copying the values from another FOperatingSystemMailSetting object.
Parameters
Section titled “Parameters”OtherThe FOperatingSystemMailSetting object to be copied.
Returns
Section titled “Returns”A new FOperatingSystemMailSetting object with copied values.
FOperatingSystemMailSetting
Section titled “FOperatingSystemMailSetting”inline
inline FOperatingSystemMailSetting(const FOperatingSystemMailSetting & Other, const FGameplayTag & NewTag)Defined in OperatingSystemMailTypes.h:245 FOperatingSystemMailSetting copy constructor.
This constructor creates a new FOperatingSystemMailSetting object by copying the values from another FOperatingSystemMailSetting object and assigns it a new category tag.
Parameters
Section titled “Parameters”-
OtherThe FOperatingSystemMailSetting object to be copied. -
NewTagThe new category tag to assign to the new FOperatingSystemMailSetting object.
Returns
Section titled “Returns”A new FOperatingSystemMailSetting object with copied values and the new category tag.
FOperatingSystemMailSetting
Section titled “FOperatingSystemMailSetting”inline
inline FOperatingSystemMailSetting(const FOperatingSystemMailSetting & Other, const FDateTime & NewReplyDate)Defined in OperatingSystemMailTypes.h:260 FOperatingSystemMailSetting constructor.
This constructor creates a new FOperatingSystemMailSetting object by copying the values from another FOperatingSystemMailSetting object and assigns it a new reply date.
Parameters
Section titled “Parameters”-
OtherThe FOperatingSystemMailSetting object to be copied. -
NewReplyDateThe new reply date to assign to the new FOperatingSystemMailSetting object.
Returns
Section titled “Returns”A new FOperatingSystemMailSetting object with copied values and the new reply date.
Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
bool | IsValidCategoryTag static inline |
IsValidCategoryTag
Section titled “IsValidCategoryTag”static inline
static inline bool IsValidCategoryTag(const FGameplayTag & TargetCategoryTag)Defined in OperatingSystemMailTypes.h:120