Navigation
API > API/Runtime > API/Runtime/Core
Basic message token that defaults is activated method to access UDN documentation.
| Name | FDocumentationToken |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h |
| Include Path | #include "Logging/TokenizedMessage.h" |
Syntax
class FDocumentationToken : public IMessageToken
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDocumentationToken
(
const FString& InDocumentationLink, |
Protected constructor | Logging/TokenizedMessage.h | |
FDocumentationToken
(
FPrivateToken, |
Logging/TokenizedMessage.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken | The private token allows only members or friends to call MakeShared. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DocumentationLink | FString | The documentation path we link to when clicked | Logging/TokenizedMessage.h | |
| PreviewExcerptLink | FString | The link we display an excerpt from | Logging/TokenizedMessage.h | |
| PreviewExcerptName | FString | The excerpt to display | Logging/TokenizedMessage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & GetDocumentationLink() |
End IMessageToken interface Get the documentation link used by this token | Logging/TokenizedMessage.h | |
const FString & GetPreviewExcerptLink() |
Get the documentation excerpt link used by this token | Logging/TokenizedMessage.h | |
const FString & GetPreviewExcerptName() |
Get the documentation excerpt name used by this token | Logging/TokenizedMessage.h |
Overridden from IMessageToken
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMessageToken::Type GetType() |
Begin IMessageToken interface | Logging/TokenizedMessage.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FDocumentationToken > Create
(
const FString& InDocumentationLink, |
Factory method, tokens can only be constructed as shared refs | Logging/TokenizedMessage.h |