GOG GALAXY SDK Documentation
ISharedFileDownloadListener Class Referenceabstract

Listener for the event of downloading a shared file. More...

#include <IStorage.h>

Inheritance diagram for ISharedFileDownloadListener:
[legend]

Public Types

enum  FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CONNECTION_FAILURE }
 The reason of a failure in downloading a shared file. More...
 

Public Member Functions

virtual void OnSharedFileDownloadSuccess (SharedFileID sharedFileID, const char *fileName)=0
 Notification for the event of a success in downloading a shared file. More...
 
virtual void OnSharedFileDownloadFailure (SharedFileID sharedFileID, FailureReason failureReason)=0
 Notification for the event of a failure in downloading a shared file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GalaxyTypeAwareListener< SHARED_FILE_DOWNLOAD >
static ListenerType GetListenerType ()
 Returns the type of the listener. More...
 

Detailed Description

Listener for the event of downloading a shared file.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in downloading a shared file.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnSharedFileDownloadFailure()

virtual void OnSharedFileDownloadFailure ( SharedFileID  sharedFileID,
FailureReason  failureReason 
)
pure virtual

Notification for the event of a failure in downloading a shared file.

Parameters
[in]sharedFileIDThe ID of the file.
[in]failureReasonThe cause of the failure.

◆ OnSharedFileDownloadSuccess()

virtual void OnSharedFileDownloadSuccess ( SharedFileID  sharedFileID,
const char *  fileName 
)
pure virtual

Notification for the event of a success in downloading a shared file.

Parameters
[in]sharedFileIDThe ID of the file.
[in]fileNameThe name of the file in the form of a path (see the description of IStorage::FileWrite()).