GOG GALAXY SDK Documentation
ICloudStorageGetFileListListener Class Referenceabstract

Listener for the event of downloading a list of files stored in cloud storage. More...

#include <ICloudStorage.h>

Inheritance diagram for ICloudStorageGetFileListListener:
[legend]

Public Types

enum  FailureReason {
  FAILURE_REASON_UNDEFINED , FAILURE_REASON_UNAUTHORIZED , FAILURE_REASON_FORBIDDEN , FAILURE_REASON_NOT_FOUND ,
  FAILURE_REASON_UNAVAILABLE , FAILURE_REASON_ABORTED , FAILURE_REASON_CONNECTION_FAILURE
}
 The reason of a failure in downloading a list of files. More...
 

Public Member Functions

virtual void OnGetFileListSuccess (uint32_t fileCount, uint32_t quota, uint32_t quotaUsed)=0
 Notification for the event of a success in downloading a list of files. More...
 
virtual void OnGetFileListFailure (FailureReason failureReason)=0
 Notification for the event of a failure in downloading a list of files. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the event of downloading a list of files stored in cloud storage.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in downloading a list of files.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_UNAUTHORIZED 

Authorization lost.

FAILURE_REASON_FORBIDDEN 

No access to specified container.

FAILURE_REASON_NOT_FOUND 

Container not found.

FAILURE_REASON_UNAVAILABLE 

Service unavailable.

FAILURE_REASON_ABORTED 

Request aborted.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnGetFileListFailure()

virtual void OnGetFileListFailure ( FailureReason  failureReason)
pure virtual

Notification for the event of a failure in downloading a list of files.

Parameters
[in]failureReasonThe cause of the failure.

◆ OnGetFileListSuccess()

virtual void OnGetFileListSuccess ( uint32_t  fileCount,
uint32_t  quota,
uint32_t  quotaUsed 
)
pure virtual

Notification for the event of a success in downloading a list of files.

In order to read info on subsequent files call ICloudStorage::GetFile*ByIndex().

Parameters
[in]fileCountFile count on the list.
[in]quotaTotal quota bytes.
[in]quotaUsedUsed quota.
Remarks
File info data is available at the time this notification comes.