Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface
Interface to access all information related to Online Sessions. Read only
| Name | ISession |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Sessions.h |
| Include Path | #include "Online/Sessions.h" |
Syntax
class ISession
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DumpState() |
Returns a string with all the information in the session | Online/Sessions.h | |
const uint32 GetNumOpenConnections() |
Retrieves the number of available slots for new session members | Online/Sessions.h | |
const FAccountId GetOwnerAccountId() |
Retrieves the id handle for the user who created or currently owns the session | Online/Sessions.h | |
const FOnlineSessionId GetSessionId() |
Retrieves the id handle for the session | Online/Sessions.h | |
const FSessionInfo & GetSessionInfo() |
Retrieves the set of constant information about the session | Online/Sessions.h | |
const FSessionMemberIdsSet & GetSessionMembers() |
Retrieves the list of users currently in the session | Online/Sessions.h | |
const FSessionSettings & GetSessionSettings() |
Retrieves the set of variable information about the session | Online/Sessions.h | |
bool IsJoinable() |
Evaluates a series of factors to determine if a session is accepting new members | Online/Sessions.h | |
FString ToLogString() |
Returns a string with the minimal information to identify the session | Online/Sessions.h |