UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMutableMessageContext Class Referenceabstract

#include <IMutableMessageContext.h>

+ Inheritance diagram for IMutableMessageContext:

Public Member Functions

virtual void AddRecipient (const FMessageAddress &Recipient)=0
 
virtual void SetAttachment (const TSharedPtr< IMessageAttachment, ESPMode::ThreadSafe > &InAttachment)=0
 
virtual void SetMessage (void *InMessage, UScriptStruct *InTypeInfo)=0
 
virtual void SetExpiration (const FDateTime &InExpiration)=0
 
virtual void SetHeader (const FName &Key, const FString &Value)=0
 
virtual void SetScope (EMessageScope InScope)=0
 
virtual void SetSender (const FMessageAddress &InSender)=0
 
virtual void SetTimeSent (const FDateTime &InTimeSent)=0
 
virtual ~IMutableMessageContext ()
 
- Public Member Functions inherited from IMessageContext
virtual const TMap< FName, FString > & GetAnnotations () const =0
 
virtual TSharedPtr< IMessageAttachment, ESPMode::ThreadSafeGetAttachment () const =0
 
virtual const FDateTimeGetExpiration () const =0
 
virtual const voidGetMessage () const =0
 
virtual const TWeakObjectPtr< UScriptStruct > & GetMessageTypeInfo () const =0
 
virtual TSharedPtr< IMessageContext, ESPMode::ThreadSafeGetOriginalContext () const =0
 
virtual const TArray< FMessageAddress > & GetRecipients () const =0
 
virtual EMessageScope GetScope () const =0
 
virtual EMessageFlags GetFlags () const =0
 
virtual const FMessageAddressGetSender () const =0
 
virtual const FMessageAddressGetForwarder () const =0
 
virtual ENamedThreads::Type GetSenderThread () const =0
 
virtual const FDateTimeGetTimeForwarded () const =0
 
virtual const FDateTimeGetTimeSent () const =0
 
FName GetMessageType () const
 
FTopLevelAssetPath GetMessageTypePathName () const
 
bool IsForwarded () const
 
bool IsValid () const
 
virtual ~IMessageContext ()
 

Detailed Description

Interface for mutable message contexts.

Constructor & Destructor Documentation

◆ ~IMutableMessageContext()

virtual IMutableMessageContext::~IMutableMessageContext ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ AddRecipient()

virtual void IMutableMessageContext::AddRecipient ( const FMessageAddress Recipient)
pure virtual

Adds a message address to the recipient list.

Parameters
RecipientThe address of the recipient to add.

◆ SetAttachment()

virtual void IMutableMessageContext::SetAttachment ( const TSharedPtr< IMessageAttachment, ESPMode::ThreadSafe > &  InAttachment)
pure virtual

Sets the optional message attachment.

Parameters
InAttachmentThe attachment to set.

◆ SetExpiration()

virtual void IMutableMessageContext::SetExpiration ( const FDateTime InExpiration)
pure virtual

Sets the date and time at which the message expires.

Parameters
InExpirationExpiration date and time.

◆ SetHeader()

virtual void IMutableMessageContext::SetHeader ( const FName Key,
const FString &  Value 
)
pure virtual

Sets the value of the header with the specified key.

Parameters
KeyThe header key.
ValueThe header value.

◆ SetMessage()

virtual void IMutableMessageContext::SetMessage ( void InMessage,
UScriptStruct InTypeInfo 
)
pure virtual

Sets the message.

Parameters
InMessageThe message to set.
InTypeInfoThe message's type information.

◆ SetScope()

virtual void IMutableMessageContext::SetScope ( EMessageScope  InScope)
pure virtual

Sets the message scope.

Parameters
InScopeThe message scope.

◆ SetSender()

virtual void IMutableMessageContext::SetSender ( const FMessageAddress InSender)
pure virtual

Sets the address of the message's sender.

Parameters
InSenderThe message sender's address.

◆ SetTimeSent()

virtual void IMutableMessageContext::SetTimeSent ( const FDateTime InTimeSent)
pure virtual

Sets the date and time at which the message was sent.

Parameters
InTimeSentSend date and time.

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