Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | List of all members
IAsyncTaskNotificationImpl Class Referenceabstract

#include <CoreAsyncTaskNotificationImpl.h>

+ Inheritance diagram for IAsyncTaskNotificationImpl:

Public Member Functions

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

Detailed Description

Implementation interface of notifications for an on-going asynchronous task.

Definition at line 21 of file CoreAsyncTaskNotificationImpl.h.

Constructor & Destructor Documentation

◆ ~IAsyncTaskNotificationImpl()

virtual IAsyncTaskNotificationImpl::~IAsyncTaskNotificationImpl ( )
virtualdefault

Member Function Documentation

◆ GetPromptAction()

virtual EAsyncTaskNotificationPromptAction IAsyncTaskNotificationImpl::GetPromptAction ( ) const
pure virtual

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

Implemented in FCoreAsyncTaskNotificationImpl.

◆ Initialize()

virtual void IAsyncTaskNotificationImpl::Initialize ( const FAsyncTaskNotificationConfig & InConfig)
pure virtual

Initialize this notification based on the given config.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetCanCancel()

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

Set whether this task be canceled.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetComplete() [1/2]

virtual void IAsyncTaskNotificationImpl::SetComplete ( const bool bSuccess)
pure virtual

Set the task as complete.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetComplete() [2/2]

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

Update the text and set the task as complete.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetHyperlink()

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

Set the hyperlink text of this notification.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetKeepOpenOnFailure()

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

Set whether to keep this notification open on failure.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetKeepOpenOnSuccess()

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

Set whether to keep this notification open on success.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetNotificationState()

virtual void IAsyncTaskNotificationImpl::SetNotificationState ( const FAsyncNotificationStateData & InState)
pure virtual

Set the task notification state. provides finer control than SetComplete

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetProgressText()

virtual void IAsyncTaskNotificationImpl::SetProgressText ( const FText & InProgressText)
pure virtual

Set the progress text of this notification.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetPromptText()

virtual void IAsyncTaskNotificationImpl::SetPromptText ( const FText & InPromptText)
pure virtual

Set the prompt text of this notification.

Implemented in FCoreAsyncTaskNotificationImpl.

◆ SetTitleText()

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

Set the title text of this notification.

Implemented in FCoreAsyncTaskNotificationImpl.

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