#include <AsyncTaskNotification.h>

Collaboration diagram for FAsyncTaskNotification:

Public Member Functions
	FAsyncTaskNotification (const FAsyncTaskNotificationConfig &InConfig)

	~FAsyncTaskNotification ()

	FAsyncTaskNotification (const FAsyncTaskNotification &)=delete

FAsyncTaskNotification &	operator= (const FAsyncTaskNotification &)=delete

	FAsyncTaskNotification (FAsyncTaskNotification &&InOther)

FAsyncTaskNotification &	operator= (FAsyncTaskNotification &&InOther)

void	SetTitleText (const FText &InTitleText, const bool bClearProgressText=true)

void	SetProgressText (const FText &InProgressText)

void	SetPromptText (const FText &InPromptText)

void	SetHyperlink (const FSimpleDelegate &InHyperlink, const FText &InHyperlinkText=FText())

void	SetComplete (const bool bSuccess=true)

void	SetComplete (const FText &InTitleText, const FText &InProgressText, const bool bSuccess=true)

void	SetNotificationState (const FAsyncNotificationStateData &InState)

void	SetCanCancel (const TAttribute< bool > &InCanCancel)

void	SetKeepOpenOnSuccess (const TAttribute< bool > &InKeepOpenOnSuccess)

void	SetKeepOpenOnFailure (const TAttribute< bool > &InKeepOpenOnFailure)

EAsyncTaskNotificationPromptAction	GetPromptAction () const

Private Attributes
TSharedPtr< IAsyncTaskNotificationImpl >	NotificationImpl

Detailed Description

Provides notifications for an on-going asynchronous task.

Definition at line 113 of file AsyncTaskNotification.h.

Constructor & Destructor Documentation

◆ FAsyncTaskNotification() [1/3]

FAsyncTaskNotification::FAsyncTaskNotification ( const FAsyncTaskNotificationConfig & InConfig )

Create an asynchronous task notification.

◆ ~FAsyncTaskNotification()

FAsyncTaskNotification::~FAsyncTaskNotification ( )

Destroy the asynchronous task notification.

◆ FAsyncTaskNotification() [2/3]

FAsyncTaskNotification::FAsyncTaskNotification ( const FAsyncTaskNotification & )

delete

Non-copyable.

◆ FAsyncTaskNotification() [3/3]

FAsyncTaskNotification::FAsyncTaskNotification ( FAsyncTaskNotification && InOther )

Movable.

Member Function Documentation

◆ GetPromptAction()

EAsyncTaskNotificationPromptAction FAsyncTaskNotification::GetPromptAction ( ) const

Return the notification prompt action. The action resets to None when the notification state changes.

◆ operator=() [1/2]

FAsyncTaskNotification & FAsyncTaskNotification::operator= ( const FAsyncTaskNotification & )

delete

◆ operator=() [2/2]

FAsyncTaskNotification & FAsyncTaskNotification::operator= ( FAsyncTaskNotification && InOther )

◆ SetCanCancel()

void FAsyncTaskNotification::SetCanCancel ( const TAttribute< bool > & InCanCancel )

Set whether this task be canceled.

◆ SetComplete() [1/2]

void FAsyncTaskNotification::SetComplete ( const bool bSuccess = true )

Set the task as complete.

◆ SetComplete() [2/2]

void FAsyncTaskNotification::SetComplete	(	const FText &	InTitleText,
		const FText &	InProgressText,
		const bool	bSuccess = true )

Update the text and set the task as complete.

◆ SetHyperlink()

void FAsyncTaskNotification::SetHyperlink	(	const FSimpleDelegate &	InHyperlink,
		const FText &	InHyperlinkText = FText() )

Set the Hyperlink for this notification.

◆ SetKeepOpenOnFailure()

void FAsyncTaskNotification::SetKeepOpenOnFailure ( const TAttribute< bool > & InKeepOpenOnFailure )

Set whether to keep this notification open on failure.

◆ SetKeepOpenOnSuccess()

void FAsyncTaskNotification::SetKeepOpenOnSuccess ( const TAttribute< bool > & InKeepOpenOnSuccess )

Set whether to keep this notification open on success.

◆ SetNotificationState()

void FAsyncTaskNotification::SetNotificationState ( const FAsyncNotificationStateData & InState )

Set the notification state. Provide finer control than SetComplete by setting every field of the state.

◆ SetProgressText()

void FAsyncTaskNotification::SetProgressText ( const FText & InProgressText )

Set the progress text of this notification.

◆ SetPromptText()

void FAsyncTaskNotification::SetPromptText ( const FText & InPromptText )

Set the prompt text of this notification, if needed.

◆ SetTitleText()

void FAsyncTaskNotification::SetTitleText	(	const FText &	InTitleText,
		const bool	bClearProgressText = true )

Set the title text of this notification.

Member Data Documentation

◆ NotificationImpl

TSharedPtr<IAsyncTaskNotificationImpl> FAsyncTaskNotification::NotificationImpl

private

Pointer to the real notification implementation

Definition at line 196 of file AsyncTaskNotification.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/AsyncTaskNotification.h

Public Member Functions

Private Attributes