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

#include <TokenizedMessage.h>

+ Inheritance diagram for IMessageToken:

Public Member Functions

virtual ~IMessageToken ()
 
virtual EMessageToken::Type GetType () const =0
 
virtual const FTextToText () const
 
virtual const FOnMessageTokenActivatedGetOnMessageTokenActivated () const
 
virtual TSharedRef< IMessageTokenOnMessageTokenActivated (FOnMessageTokenActivated InMessageTokenActivated)
 
- Public Member Functions inherited from TSharedFromThis< IMessageToken >
TSharedRef< IMessageToken, Mode > AsShared ()
 
TSharedRef< IMessageToken const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IMessageToken, Mode > AsWeak ()
 
TWeakPtr< IMessageToken const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Attributes

FOnMessageTokenActivated MessageTokenActivated
 
FText CachedText
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< IMessageToken >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< IMessageToken >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

A single message token for a FTokenizedMessage instance

Constructor & Destructor Documentation

◆ ~IMessageToken()

virtual IMessageToken::~IMessageToken ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ GetOnMessageTokenActivated()

virtual const FOnMessageTokenActivated & IMessageToken::GetOnMessageTokenActivated ( ) const
inlinevirtual

Get the activated delegate associated with this token, if any

Returns
a reference to the delegate

Reimplemented in FActorToken, FAssetDataToken, and FUObjectToken.

◆ GetType()

virtual EMessageToken::Type IMessageToken::GetType ( ) const
pure virtual

◆ OnMessageTokenActivated()

virtual TSharedRef< IMessageToken > IMessageToken::OnMessageTokenActivated ( FOnMessageTokenActivated  InMessageTokenActivated)
inlinevirtual

Set the activated delegate associated with this token

Returns
a reference to this token, for chaining

◆ ToText()

virtual const FText & IMessageToken::ToText ( ) const
inlinevirtual

Get a string representation of this token

Returns
a string representing this token

Reimplemented in FDynamicTextToken.

Member Data Documentation

◆ CachedText

FText IMessageToken::CachedText
protected

Cached string representation of this token

◆ MessageTokenActivated

FOnMessageTokenActivated IMessageToken::MessageTokenActivated
protected

A delegate for when this token is activated (e.g. hyperlink clicked)


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