FCoreAsyncTaskNotificationImpl

Basic asynchronous task notification that just logs status changes.

Windows
MacOS
Linux

Inheritance Hierarchy

IAsyncTaskNotificationImpl

FCoreAsyncTaskNotificationImpl

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/CoreAsyncTaskNotificationImpl.h

Include

#include "Misc/CoreAsyncTaskNotificationImpl.h"

Syntax

class FCoreAsyncTaskNotificationImpl : public IAsyncTaskNotificationImpl

Remarks

Basic asynchronous task notification that just logs status changes.

Variables

Name Description

Protected variable

FSimpleDelegate

 

Hyperlink

When set this will display as a hyperlink on the right side of the notification.

Protected variable

FText

 

HyperlinkText

Text to display for the hyperlink message

Protected variable

FText

 

ProgressText

The progress text displayed in the notification (if any)

Protected variable

FText

 

PromptText

The progress text displayed in the notification (if any)

Protected variable

EAsyncTaskNotif...

 

State

The current state of this notification

Protected variable

FText

 

TitleText

The title text displayed in the notification (if any)

Constructors

Destructors

Functions

Name Description

Protected function Virtual

void

 

UpdateNotification()

Update the notification (the critical section is held while this function is called)

Overridden from IAsyncTaskNotificationImpl

Name Description

Public function Virtual Const

EAsyncTaskNo...

 

GetPromptAction()

Return the notification prompt action.

Public function Virtual

void

 

Initialize

(
    const FAsyncTaskNotificationConfig ...
)

Initialize this notification based on the given config.

Public function Virtual

void

 

SetCanCancel

(
    const TAttribute< bool >& InCanCan...
)

Set whether this task be canceled.

Public function Virtual

void

 

SetComplete

(
    const bool bSuccess
)

Set the task as complete.

Public function Virtual

void

 

SetComplete

(
    const FText& InTitleText,
    const FText& InProgressText,
    const bool bSuccess
)

Update the text and set the task as complete.

Public function Virtual

void

 

SetHyperlink

(
    const FSimpleDelegate& InHyperlink,
    const FText& InHyperlinkText
)

Set the hyperlink text of this notification.

Public function Virtual

void

 

SetKeepOpenOnFailure

(
    const TAttribute< bool >& InKeepOp...
)

Set whether to keep this notification open on failure.

Public function Virtual

void

 

SetKeepOpenOnSuccess

(
    const TAttribute< bool >& InKeepOp...
)

Set whether to keep this notification open on success.

Public function Virtual

void

 

SetNotificationState

(
    const FAsyncNotificationStateData&...
)

Set the task notification state. provides finer control than SetComplete

Public function Virtual

void

 

SetProgressText

(
    const FText& InProgressText
)

Set the progress text of this notification.

Public function Virtual

void

 

SetPromptText

(
    const FText& InPromptText
)

Set the prompt text of this notification.

Public function Virtual

void

 

SetTitleText

(
    const FText& InTitleText,
    const bool bClearProgressText
)

Set the title text of this notification.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss