FCoreAsyncTaskNotificationImpl Class Reference

#include <CoreAsyncTaskNotificationImpl.h>

Inheritance diagram for FCoreAsyncTaskNotificationImpl:

Collaboration diagram for FCoreAsyncTaskNotificationImpl:

Public Member Functions
	FCoreAsyncTaskNotificationImpl ()
virtual	~FCoreAsyncTaskNotificationImpl ()
virtual void	Initialize (const FAsyncTaskNotificationConfig &InConfig) override
virtual void	SetTitleText (const FText &InTitleText, const bool bClearProgressText) override
virtual void	SetProgressText (const FText &InProgressText) override
virtual void	SetPromptText (const FText &InPromptText) override
virtual void	SetHyperlink (const FSimpleDelegate &InHyperlink, const FText &InHyperlinkText) override
virtual void	SetComplete (const bool bSuccess) override
virtual void	SetComplete (const FText &InTitleText, const FText &InProgressText, const bool bSuccess) override
virtual void	SetNotificationState (const FAsyncNotificationStateData &InState) override
virtual void	SetCanCancel (const TAttribute< bool > &InCanCancel) override
virtual void	SetKeepOpenOnSuccess (const TAttribute< bool > &InKeepOpenOnSuccess) override
virtual void	SetKeepOpenOnFailure (const TAttribute< bool > &InKeepOpenOnFailure) override
virtual EAsyncTaskNotificationPromptAction	GetPromptAction () const override
Public Member Functions inherited from IAsyncTaskNotificationImpl
virtual	~IAsyncTaskNotificationImpl ()=default

Protected Member Functions
virtual void	UpdateNotification ()

Protected Attributes
EAsyncTaskNotificationState	State = EAsyncTaskNotificationState::Pending
FText	TitleText
FText	ProgressText
FText	PromptText
FSimpleDelegate	Hyperlink
FText	HyperlinkText

Private Member Functions
void	LogNotification ()

Private Attributes
const FLogCategoryBase *	LogCategory = nullptr
FCriticalSection	SynchronizationObject

Detailed Description

Basic asynchronous task notification that just logs status changes.

Definition at line 91 of file CoreAsyncTaskNotificationImpl.h.

Constructor & Destructor Documentation

FCoreAsyncTaskNotificationImpl()

FCoreAsyncTaskNotificationImpl::FCoreAsyncTaskNotificationImpl

(

)

~FCoreAsyncTaskNotificationImpl()

virtual FCoreAsyncTaskNotificationImpl::~FCoreAsyncTaskNotificationImpl ( )

virtual

Member Function Documentation

GetPromptAction()

virtual EAsyncTaskNotificationPromptAction FCoreAsyncTaskNotificationImpl::GetPromptAction ( ) const

overridevirtual

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

Implements IAsyncTaskNotificationImpl.

Initialize()

virtual void FCoreAsyncTaskNotificationImpl::Initialize ( const FAsyncTaskNotificationConfig & InConfig )

overridevirtual

Initialize this notification based on the given config.

Implements IAsyncTaskNotificationImpl.

LogNotification()

void FCoreAsyncTaskNotificationImpl::LogNotification ( )

private

Log the current notification state (if any, and if enabled)

SetCanCancel()

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

overridevirtual

Set whether this task be canceled.

Implements IAsyncTaskNotificationImpl.

SetComplete() [1/2]

virtual void FCoreAsyncTaskNotificationImpl::SetComplete ( const bool bSuccess )

overridevirtual

Set the task as complete.

Implements IAsyncTaskNotificationImpl.

SetComplete() [2/2]

virtual void FCoreAsyncTaskNotificationImpl::SetComplete ( const FText & InTitleText, const FText & InProgressText, const bool bSuccess )

overridevirtual

Update the text and set the task as complete.

Implements IAsyncTaskNotificationImpl.

SetHyperlink()

virtual void FCoreAsyncTaskNotificationImpl::SetHyperlink ( const FSimpleDelegate & InHyperlink, const FText & InHyperlinkText )

overridevirtual

Set the hyperlink text of this notification.

Implements IAsyncTaskNotificationImpl.

SetKeepOpenOnFailure()

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

overridevirtual

Set whether to keep this notification open on failure.

Implements IAsyncTaskNotificationImpl.

SetKeepOpenOnSuccess()

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

overridevirtual

Set whether to keep this notification open on success.

Implements IAsyncTaskNotificationImpl.

SetNotificationState()

virtual void FCoreAsyncTaskNotificationImpl::SetNotificationState ( const FAsyncNotificationStateData & InState )

overridevirtual

Set the task notification state. provides finer control than SetComplete

Implements IAsyncTaskNotificationImpl.

SetProgressText()

virtual void FCoreAsyncTaskNotificationImpl::SetProgressText ( const FText & InProgressText )

overridevirtual

Set the progress text of this notification.

Implements IAsyncTaskNotificationImpl.

SetPromptText()

virtual void FCoreAsyncTaskNotificationImpl::SetPromptText ( const FText & InPromptText )

overridevirtual

Set the prompt text of this notification.

Implements IAsyncTaskNotificationImpl.

SetTitleText()

virtual void FCoreAsyncTaskNotificationImpl::SetTitleText ( const FText & InTitleText, const bool bClearProgressText )

overridevirtual

Set the title text of this notification.

Implements IAsyncTaskNotificationImpl.

UpdateNotification()

virtual void FCoreAsyncTaskNotificationImpl::UpdateNotification ( )

protectedvirtual

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

Member Data Documentation

Hyperlink

FSimpleDelegate FCoreAsyncTaskNotificationImpl::Hyperlink

protected

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

Definition at line 128 of file CoreAsyncTaskNotificationImpl.h.

HyperlinkText

FText FCoreAsyncTaskNotificationImpl::HyperlinkText

protected

Text to display for the hyperlink message

Definition at line 131 of file CoreAsyncTaskNotificationImpl.h.

LogCategory

const FLogCategoryBase* FCoreAsyncTaskNotificationImpl::LogCategory = nullptr

private

Category this task should log its notifications under, or null to skip logging

Definition at line 137 of file CoreAsyncTaskNotificationImpl.h.

ProgressText

FText FCoreAsyncTaskNotificationImpl::ProgressText

protected

The progress text displayed in the notification (if any)

Definition at line 122 of file CoreAsyncTaskNotificationImpl.h.

PromptText

FText FCoreAsyncTaskNotificationImpl::PromptText

protected

The progress text displayed in the notification (if any)

Definition at line 125 of file CoreAsyncTaskNotificationImpl.h.

State

EAsyncTaskNotificationState FCoreAsyncTaskNotificationImpl::State = EAsyncTaskNotificationState::Pending

protected

The current state of this notification

Definition at line 116 of file CoreAsyncTaskNotificationImpl.h.

SynchronizationObject

FCriticalSection FCoreAsyncTaskNotificationImpl::SynchronizationObject

mutableprivate

Critical section protecting concurrent access to this object state

Definition at line 140 of file CoreAsyncTaskNotificationImpl.h.

TitleText

FText FCoreAsyncTaskNotificationImpl::TitleText

protected

The title text displayed in the notification (if any)

Definition at line 119 of file CoreAsyncTaskNotificationImpl.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/CoreAsyncTaskNotificationImpl.h