Navigation
API > API/Runtime > API/Runtime/SessionServices
Interface for the session manager.
| Name | ISessionManager |
| Type | class |
| Header File | /Engine/Source/Runtime/SessionServices/Public/ISessionManager.h |
| Include Path | #include "ISessionManager.h" |
Syntax
class ISessionManager
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISessionManager() |
Virtual destructor. | ISessionManager.h |
Classes
| Name | Remarks |
|---|---|
| FCanSelectSessionEvent | Returns a delegate that is executed before a session is being selected. |
| FInstanceSelectionChangedEvent | Returns a delegate that is executed when an instance changes its selection state. |
| FLogReceivedEvent | Returns a delegate that is executed when the selected session received a log message from one of its instances. |
| FSelectedSessionChangedEvent | Returns a delegate that is executed when the selected session changed. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnInstanceSelectionChanged | ISessionManager::FLogReceivedEvent & | ISessionManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddOwner
(
const FString& InOwner |
Adds an owner whose sessions we are interested in | ISessionManager.h | |
TSharedPtr< ISessionInstanceInfo > GetInstance
(
const FGuid& Id |
Attempts to retrieve an instance by it's unique instance id. | ISessionManager.h | |
const TArray< TSharedPtr< ISessionInstanceInfo > > & GetSelectedInstances() |
Gets the collection of currently selected engine instances. | ISessionManager.h | |
const TSharedPtr< ISessionInfo > & GetSelectedSession() |
Get the selected session - as chosen in the session browser | ISessionManager.h | |
void GetSessions
(
TArray< TSharedPtr< ISessionInfo > >& OutSessions |
Gets the list of all discovered sessions. | ISessionManager.h | |
bool IsInstanceSelected
(
const TSharedRef< ISessionInstanceInfo >& Instance |
Checks whether the given instance is currently selected. | ISessionManager.h | |
ISessionManager::FCanSelectSessionEvent TBaseMulticastDelegate_TwoParams OnCanSelectSession() |
ISessionManager.h | ||
ISessionManager::FInstanceSelectionChangedEvent TBaseMulticastDelegate_TwoParams OnInstanceSelectionChanged() |
ISessionManager.h | ||
FLogReceivedEvent & OnLogReceived() |
ISessionManager.h | ||
ISessionManager::FSelectedSessionChangedEvent TBaseMulticastDelegate_OneParam OnSelectedSessionChanged() |
ISessionManager.h | ||
FSimpleMulticastDelegate & OnSessionInstanceUpdated() |
Returns a delegate that is executed when a session instance is updated. | ISessionManager.h | |
FSimpleMulticastDelegate & OnSessionsUpdated() |
Returns a delegate that is executed when the list of sessions has changed. | ISessionManager.h | |
void RemoveOwner
(
const FString& InOwner |
Removes an owner whose sessions we are no longer interested in | ISessionManager.h | |
bool SelectSession
(
const TSharedPtr< ISessionInfo >& Session |
Selects the specified session. | ISessionManager.h | |
bool SetInstanceSelected
(
const TSharedRef< ISessionInstanceInfo >& Instance, |
Marks the specified item as selected or unselected. | ISessionManager.h |