FAsyncTaskNotification

Provides notifications for an on-going asynchronous task.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Misc/AsyncTaskNotification.h"

Syntax

class FAsyncTaskNotification

Remarks

Provides notifications for an on-going asynchronous task.

Constructors

Name Description

Public function

FAsyncTaskNotification

(
    const FAsyncTaskNotificationConfig ...
)

Create an asynchronous task notification.

Public function

FAsyncTaskNotification

(
    const FAsyncTaskNotification&
)

Non-copyable.

Public function

FAsyncTaskNotification

(
    FAsyncTaskNotification&& InOther
)

Movable.

Destructors

Name Description

Public function

~FAsyncTaskNotification()

Destroy the asynchronous task notification.

Functions

Name Description

Public function Const

EAsyncTaskNo...

 

GetPromptAction()

Return the notification prompt action.

Public function

void

 

SetCanCancel

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

Set whether this task be canceled.

Public function

void

 

SetComplete

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

Update the text and set the task as complete.

Public function

void

 

SetComplete

(
    const bool bSuccess
)

Set the task as complete.

Public function

void

 

SetHyperlink

(
    const FSimpleDelegate& InHyperlink,
    const FText& InHyperlinkText
)

Set the Hyperlink for this notification.

Public function

void

 

SetKeepOpenOnFailure

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

Set whether to keep this notification open on failure.

Public function

void

 

SetKeepOpenOnSuccess

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

Set whether to keep this notification open on success.

Public function

void

 

SetNotificationState

(
    const FAsyncNotificationStateData&...
)

Set the notification state.

Public function

void

 

SetProgressText

(
    const FText& InProgressText
)

Set the progress text of this notification.

Public function

void

 

SetPromptText

(
    const FText& InPromptText
)

Set the prompt text of this notification, if needed.

Public function

void

 

SetTitleText

(
    const FText& InTitleText,
    const bool bClearProgressText
)

Set the title text of this notification.

Operators

Name Description

Public function

FAsyncTaskNo...

 

operator=

(
    FAsyncTaskNotification&& InOther
)

Public function

FAsyncTaskNo...

 

operator=

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