GOG GALAXY SDK Documentation
GalaxyApi.h
Go to the documentation of this file.
1 #ifndef GALAXY_API_H
2 #define GALAXY_API_H
3 
9 #include "GalaxyExport.h"
10 #include "InitOptions.h"
11 #include "ShutdownOptions.h"
12 #include "IUser.h"
13 #include "IFriends.h"
14 #include "IChat.h"
15 #include "IMatchmaking.h"
16 #include "INetworking.h"
17 #include "IStats.h"
18 #include "IUtils.h"
19 #include "IApps.h"
20 #include "IStorage.h"
21 #include "ICustomNetworking.h"
22 #include "ILogger.h"
23 #include "ITelemetry.h"
24 #include "ICloudStorage.h"
25 #include "Errors.h"
26 
27 #include <cstddef>
28 
29 namespace galaxy
30 {
31  namespace api
32  {
342  GALAXY_DLL_EXPORT void GALAXY_CALLTYPE Init(const InitOptions& initOptions);
343 
352  GALAXY_DLL_EXPORT void GALAXY_CALLTYPE Shutdown();
353 
364  GALAXY_DLL_EXPORT void GALAXY_CALLTYPE ShutdownEx(const ShutdownOptions& shutdownOptions);
365 
371  GALAXY_DLL_EXPORT IUser* GALAXY_CALLTYPE User();
372 
378  GALAXY_DLL_EXPORT IFriends* GALAXY_CALLTYPE Friends();
379 
385  GALAXY_DLL_EXPORT IChat* GALAXY_CALLTYPE Chat();
386 
392  GALAXY_DLL_EXPORT IMatchmaking* GALAXY_CALLTYPE Matchmaking();
393 
400  GALAXY_DLL_EXPORT INetworking* GALAXY_CALLTYPE Networking();
401 
407  GALAXY_DLL_EXPORT IStats* GALAXY_CALLTYPE Stats();
408 
414  GALAXY_DLL_EXPORT IUtils* GALAXY_CALLTYPE Utils();
415 
421  GALAXY_DLL_EXPORT IApps* GALAXY_CALLTYPE Apps();
422 
428  GALAXY_DLL_EXPORT IStorage* GALAXY_CALLTYPE Storage();
429 
435  GALAXY_DLL_EXPORT ICustomNetworking* GALAXY_CALLTYPE CustomNetworking();
436 
442  GALAXY_DLL_EXPORT ILogger* GALAXY_CALLTYPE Logger();
443 
449  GALAXY_DLL_EXPORT ITelemetry* GALAXY_CALLTYPE Telemetry();
450 
456  GALAXY_DLL_EXPORT ICloudStorage* GALAXY_CALLTYPE CloudStorage();
457 
470  GALAXY_DLL_EXPORT void GALAXY_CALLTYPE ProcessData();
471 
476  }
477 }
478 
479 #endif
Contains classes representing exceptions.
Contains a macro used for DLL export.
Contains data structures and interfaces related to application activities.
Contains data structures and interfaces related to chat communication with other Galaxy Users.
Contains data structures and interfaces related to cross-platform cloud storage activities.
Contains data structures and interfaces related to communicating with custom endpoints.
Contains data structures and interfaces related to social activities.
Contains data structures and interfaces related to logging.
Contains data structures and interfaces related to matchmaking.
Contains data structures and interfaces related to communicating with other Galaxy Peers.
Contains data structures and interfaces related to statistics, achievements and leaderboards.
Contains data structures and interfaces related to storage activities.
Contains data structures and interfaces related to telemetry.
Contains data structures and interfaces related to user account.
Contains data structures and interfaces related to common activities.
Contains class that holds Galaxy initialization parameters.
Contains class that holds Galaxy shutdown parameters.
The interface for managing application activities.
Definition: IApps.h:68
The interface for chat communication with other Galaxy Users.
Definition: IChat.h:197
The interface for cross-platform CloudStorage file management.
Definition: ICloudStorage.h:210
The interface for communicating with a custom endpoint.
Definition: ICustomNetworking.h:120
The interface for managing social info and activities.
Definition: IFriends.h:621
The interface for logging.
Definition: ILogger.h:22
The interface for managing game lobbies.
Definition: IMatchmaking.h:446
The interface for communicating with other Galaxy Peers.
Definition: INetworking.h:118
The interface for managing statistics, achievements and leaderboards.
Definition: IStats.h:363
The interface for managing of cloud storage files.
Definition: IStorage.h:106
The interface for handling telemetry.
Definition: ITelemetry.h:76
The interface for handling the user account.
Definition: IUser.h:331
The interface for managing images.
Definition: IUtils.h:142
GALAXY_DLL_EXPORT void GALAXY_CALLTYPE Shutdown()
Shuts down the Galaxy Peer.
GALAXY_DLL_EXPORT IUtils *GALAXY_CALLTYPE Utils()
Returns an instance of IUtils.
GALAXY_DLL_EXPORT IStorage *GALAXY_CALLTYPE Storage()
Returns an instance of IStorage.
GALAXY_DLL_EXPORT void GALAXY_CALLTYPE ProcessData()
Makes the Galaxy Peer process its input and output streams.
GALAXY_DLL_EXPORT INetworking *GALAXY_CALLTYPE Networking()
Returns an instance of INetworking that allows to communicate as a regular lobby member.
GALAXY_DLL_EXPORT IFriends *GALAXY_CALLTYPE Friends()
Returns an instance of IFriends.
GALAXY_DLL_EXPORT ITelemetry *GALAXY_CALLTYPE Telemetry()
Returns an instance of ITelemetry.
GALAXY_DLL_EXPORT IMatchmaking *GALAXY_CALLTYPE Matchmaking()
Returns an instance of IMatchmaking.
GALAXY_DLL_EXPORT IApps *GALAXY_CALLTYPE Apps()
Returns an instance of IApps.
GALAXY_DLL_EXPORT IStats *GALAXY_CALLTYPE Stats()
Returns an instance of IStats.
GALAXY_DLL_EXPORT void GALAXY_CALLTYPE ShutdownEx(const ShutdownOptions &shutdownOptions)
Shuts down the Galaxy Peer.
GALAXY_DLL_EXPORT IChat *GALAXY_CALLTYPE Chat()
Returns an instance of IChat.
GALAXY_DLL_EXPORT void GALAXY_CALLTYPE Init(const InitOptions &initOptions)
Initializes the Galaxy Peer with specified credentials.
GALAXY_DLL_EXPORT ILogger *GALAXY_CALLTYPE Logger()
Returns an instance of ILogger.
GALAXY_DLL_EXPORT ICustomNetworking *GALAXY_CALLTYPE CustomNetworking()
Returns an instance of ICustomNetworking.
GALAXY_DLL_EXPORT IUser *GALAXY_CALLTYPE User()
Returns an instance of IUser.
GALAXY_DLL_EXPORT ICloudStorage *GALAXY_CALLTYPE CloudStorage()
Returns an instance of ICloudStorage.
The group of options used for Init configuration.
Definition: InitOptions.h:27
The group of options used for Shutdown options.
Definition: ShutdownOptions.h:22