1. Epic GamesDeveloper
  3. IOnlineSession

IOnlineSession

Interface definition for the online services session services Session services are defined as anything related managing a session and its state within a platform service

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface definition for the online services session services Session services are defined as anything related managing a session and its state within a platform service

   
Name IOnlineSession
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineSessionInterface.h
Include Path #include "Interfaces/OnlineSessionInterface.h"

Syntax

class IOnlineSession

Constructors

Name Remarks Include Path Unreal Specifiers

IOnlineSession()

 Hidden on purpose Interfaces/OnlineSessionInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineSession()

   Interfaces/OnlineSessionInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnCancelFindSessionsCompleteDelegates FOnCancelFindSessionsComplete Delegate fired when the cancellation of a search for an online session has completed Interfaces/OnlineSessionInterface.h  
OnCancelMatchmakingCompleteDelegates FOnCancelMatchmakingComplete Delegate fired when the cloud matchmaking has been canceled Interfaces/OnlineSessionInterface.h  
OnCreateSessionCompleteDelegates FOnCreateSessionComplete Delegate fired when a session create request has completed Interfaces/OnlineSessionInterface.h  
OnDestroySessionCompleteDelegates FOnDestroySessionComplete Delegate fired when a destroying an online session has completed Interfaces/OnlineSessionInterface.h  
OnDestroySessionRequestedDelegates FOnDestroySessionRequested   Interfaces/OnlineSessionInterface.h  
OnEndSessionCompleteDelegates FOnEndSessionComplete Delegate fired when the online session has transitioned to the ending state Interfaces/OnlineSessionInterface.h  
OnFindFriendSessionCompleteDelegates FOnFindFriendSessionComplete Delegate fired once the find friend task has completed Session has not been joined at this point, and still requires a call to JoinSession() Interfaces/OnlineSessionInterface.h  
OnFindSessionsCompleteDelegates FOnFindSessionsComplete Delegate fired when the search for an online session has completed Interfaces/OnlineSessionInterface.h  
OnJoinSessionCompleteDelegates FOnJoinSessionComplete Delegate fired when the process for a local user joining an online session has completed Interfaces/OnlineSessionInterface.h  
OnMatchmakingCompleteDelegates FOnMatchmakingComplete Delegate fired when the cloud matchmaking has completed Interfaces/OnlineSessionInterface.h  
OnPingSearchResultsCompleteDelegates FOnPingSearchResultsComplete Delegate fired when an individual server's query has completed Interfaces/OnlineSessionInterface.h  
OnQosDataRequestedDelegates FOnQosDataRequested Delegate fired when session is requesting QOS measurements Interfaces/OnlineSessionInterface.h  
OnRegisterPlayersCompleteDelegates FOnRegisterPlayersComplete Delegate fired when the session registration process has completed Interfaces/OnlineSessionInterface.h  
OnSessionFailureDelegates FOnSessionFailure Delegate fired when an unexpected error occurs that impacts session connectivity or use Interfaces/OnlineSessionInterface.h  
OnSessionInviteReceivedDelegates FOnSessionInviteReceived Called when a user receives a session invitation. Interfaces/OnlineSessionInterface.h  
OnSessionParticipantJoinedDelegates FOnSessionParticipantJoined Delegate fired when a player joins a session Interfaces/OnlineSessionInterface.h  
OnSessionParticipantLeftDelegates FOnSessionParticipantLeft Delegate fired when a player leaves a session Interfaces/OnlineSessionInterface.h  
OnSessionParticipantSettingsUpdatedDelegates FOnSessionParticipantSettingsUpdated Delegate fired when a session's member settings have changed Interfaces/OnlineSessionInterface.h  
OnSessionSettingsUpdatedDelegates FOnSessionSettingsUpdated Delegate fired when a session's settings have changed Interfaces/OnlineSessionInterface.h  
OnSessionUserInviteAcceptedDelegates FOnSessionUserInviteAccepted Called when a user accepts a session invitation. Interfaces/OnlineSessionInterface.h  
OnStartSessionCompleteDelegates FOnStartSessionComplete Delegate fired when the online session has transitioned to the started state Interfaces/OnlineSessionInterface.h  
OnUnregisterPlayersCompleteDelegates FOnUnregisterPlayersComplete Delegate fired when the un-registration process has completed Interfaces/OnlineSessionInterface.h  
OnUpdateSessionCompleteDelegates FOnUpdateSessionComplete Delegate fired when a update request has completed Interfaces/OnlineSessionInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnCancelFindSessionsCompleteDelegate_Handle ( const FOnCancelFindSessionsCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnCancelMatchmakingCompleteDelegate_Handle ( const FOnCancelMatchmakingCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnCreateSessionCompleteDelegate_Handle ( const FOnCreateSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnDestroySessionCompleteDelegate_Handle ( const FOnDestroySessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnDestroySessionRequestedDelegate_Handle ( const FOnDestroySessionRequestedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnEndSessionCompleteDelegate_Handle ( const FOnEndSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnFindFriendSessionCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnFindFriendSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnFindSessionsCompleteDelegate_Handle ( const FOnFindSessionsCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnJoinSessionCompleteDelegate_Handle ( const FOnJoinSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnMatchmakingCompleteDelegate_Handle ( const FOnMatchmakingCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnPingSearchResultsCompleteDelegate_Handle ( const FOnPingSearchResultsCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnQosDataRequestedDelegate_Handle ( const FOnQosDataRequestedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnRegisterPlayersCompleteDelegate_Handle ( const FOnRegisterPlayersCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionFailureDelegate_Handle ( const FOnSessionFailureDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionInviteReceivedDelegate_Handle ( const FOnSessionInviteReceivedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionParticipantJoinedDelegate_Handle ( const FOnSessionParticipantJoinedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionParticipantLeftDelegate_Handle ( const FOnSessionParticipantLeftDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionParticipantSettingsUpdatedDelegate_Handle ( const FOnSessionParticipantSettingsUpdatedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionSettingsUpdatedDelegate_Handle ( const FOnSessionSettingsUpdatedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnSessionUserInviteAcceptedDelegate_Handle ( const FOnSessionUserInviteAcceptedDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnStartSessionCompleteDelegate_Handle ( const FOnStartSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnUnregisterPlayersCompleteDelegate_Handle ( const FOnUnregisterPlayersCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

virtual FDelegateHandle AddOnUpdateSessionCompleteDelegate_Handle ( const FOnUpdateSessionCompleteDelegate& Delegate
)

   Interfaces/OnlineSessionInterface.h  

bool CancelFindSessions()

 Cancels the current search in progress if possible for that search type Interfaces/OnlineSessionInterface.h  

bool CancelMatchmaking ( int32 SearchingPlayerNum,
FName SessionName
)

 Cancel a Matchmaking request for a given session name Interfaces/OnlineSessionInterface.h  

bool CancelMatchmaking ( const FUniqueNetId& SearchingPlayerId,
FName SessionName
)

 Cancel a Matchmaking request for a given session name Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCancelFindSessionsCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCancelFindSessionsCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCancelMatchmakingCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCancelMatchmakingCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCreateSessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnCreateSessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnDestroySessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnDestroySessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnDestroySessionRequestedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnDestroySessionRequestedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnEndSessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnEndSessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnFindFriendSessionCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnFindFriendSessionCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnFindSessionsCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnFindSessionsCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnJoinSessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnJoinSessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnMatchmakingCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnMatchmakingCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnPingSearchResultsCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnPingSearchResultsCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnQosDataRequestedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnQosDataRequestedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnRegisterPlayersCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnRegisterPlayersCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionFailureDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionFailureDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionInviteReceivedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionInviteReceivedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantJoinedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantJoinedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantLeftDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantLeftDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantSettingsUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionParticipantSettingsUpdatedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionSettingsUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionSettingsUpdatedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionUserInviteAcceptedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnSessionUserInviteAcceptedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnStartSessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnStartSessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnUnregisterPlayersCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnUnregisterPlayersCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnUpdateSessionCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineSessionInterface.h  

virtual void ClearOnUpdateSessionCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineSessionInterface.h  

bool CreateSession ( int32 HostingPlayerNum,
FName SessionName,
const FOnlineSessionSettings& NewSessionSettings
)

 Creates an online session based upon the settings object specified. Interfaces/OnlineSessionInterface.h  

bool CreateSession ( const FUniqueNetId& HostingPlayerId,
FName SessionName,
const FOnlineSessionSettings& NewSessionSettings
)

 Creates an online session based upon the settings object specified. Interfaces/OnlineSessionInterface.h  

FUniqueNetIdPtr CreateSessionIdFromString ( const FString& SessionIdStr
)

 Create a session id from a string Interfaces/OnlineSessionInterface.h  

bool DestroySession ( FName SessionName,
const FOnDestroySessionCompleteDelegate& CompletionDelegate
)

 Destroys the specified online session NOTE: online session de-registration is an async process and does not complete until the OnDestroySessionComplete delegate is called. Interfaces/OnlineSessionInterface.h  

void DumpSessionState()

 Dumps out the session state for all known sessions Interfaces/OnlineSessionInterface.h  

bool EndSession ( FName SessionName
)

 Marks an online session as having been ended Interfaces/OnlineSessionInterface.h  

bool FindFriendSession ( int32 LocalUserNum,
const FUniqueNetId& Friend
)

 Allows the local player to follow a friend into a session Interfaces/OnlineSessionInterface.h  

bool FindFriendSession ( const FUniqueNetId& LocalUserId,
const FUniqueNetId& Friend
)

 Allows the local player to follow a friend into a session Interfaces/OnlineSessionInterface.h  

bool FindFriendSession ( const FUniqueNetId& LocalUserId,
const TArray< FUniqueNetIdRef >& FriendList
)

 Allows the local player to retrieve the session of multiple friends Interfaces/OnlineSessionInterface.h  

bool FindSessionById ( const FUniqueNetId& SearchingUserId,
const FUniqueNetId& SessionId,
const FUniqueNetId& FriendId,
const FOnSingleSessionResultCompleteDelegate& CompletionDelegate
)

 Find a single advertised session by session id Interfaces/OnlineSessionInterface.h  

virtual bool FindSessionById ( const FUniqueNetId& SearchingUserId,
const FUniqueNetId& SessionId,
const FUniqueNetId& FriendId,
const FString& UserData,
const FOnSingleSessionResultCompleteDelegate& CompletionDelegate
)

 Find a single advertised session by session id (with userdata) Interfaces/OnlineSessionInterface.h  

bool FindSessions ( int32 SearchingPlayerNum,
const TSharedRef< FOnlineSessionSearch >& SearchSettings
)

 Searches for sessions matching the settings specified Interfaces/OnlineSessionInterface.h  

bool FindSessions ( const FUniqueNetId& SearchingPlayerId,
const TSharedRef< FOnlineSessionSearch >& SearchSettings
)

 Searches for sessions matching the settings specified Interfaces/OnlineSessionInterface.h  

FNamedOnlineSession * GetNamedSession ( FName SessionName
)

 Searches the named session array for the specified session Interfaces/OnlineSessionInterface.h  

int32 GetNumSessions()

 Gets the number of known sessions registered with the interface Interfaces/OnlineSessionInterface.h  

bool GetResolvedConnectString ( const FOnlineSessionSearchResult& SearchResult,
FName PortType,
FString& ConnectInfo
)

 Returns the platform specific connection information for joining a search result. Interfaces/OnlineSessionInterface.h  

bool GetResolvedConnectString ( FName SessionName,
FString& ConnectInfo,
FName PortType
)

 Returns the platform specific connection information for joining the match. Interfaces/OnlineSessionInterface.h  

FOnlineSessionSettings * GetSessionSettings ( FName SessionName
)

 Returns the session settings object for the session with a matching name Interfaces/OnlineSessionInterface.h  

EOnlineSessionState::Type GetSessionState ( FName SessionName
) const

 Get the current state of a named session Interfaces/OnlineSessionInterface.h  

virtual FString GetVoiceChatRoomName ( int32 LocalUserNum,
const FName& SessionName
)

 Returns the name for the Voice Chat room, if any were created by setting bUseLobbiesVoiceChatIfAvailable to true during session creation Interfaces/OnlineSessionInterface.h  

bool HasPresenceSession()

 Searches the named session array for any presence enabled session Interfaces/OnlineSessionInterface.h  

bool IsPlayerInSession ( FName SessionName,
const FUniqueNetId& UniqueId
)

 Determine if the player is registered in the specified session Interfaces/OnlineSessionInterface.h  

bool JoinSession ( const FUniqueNetId& LocalUserId,
FName SessionName,
const FOnlineSessionSearchResult& DesiredSession
)

 Joins the session specified Interfaces/OnlineSessionInterface.h  

bool JoinSession ( int32 LocalUserNum,
FName SessionName,
const FOnlineSessionSearchResult& DesiredSession
)

 Joins the session specified Interfaces/OnlineSessionInterface.h  

bool PingSearchResults ( const FOnlineSessionSearchResult& SearchResult
)

 Fetches the additional data a session exposes outside of the online service. Interfaces/OnlineSessionInterface.h  

void RegisterLocalPlayer ( const FUniqueNetId& PlayerId,
FName SessionName,
const FOnRegisterLocalPlayerCompleteDelegate& Delegate
)

 Registers a local player with a session. Interfaces/OnlineSessionInterface.h  

bool RegisterPlayer ( FName SessionName,
const FUniqueNetId& PlayerId,
bool bWasInvited
)

 Registers a player with the online service as being part of the online session Interfaces/OnlineSessionInterface.h  

bool RegisterPlayers ( FName SessionName,
const TArray< FUniqueNetIdRef >& Players,
bool bWasInvited
)

 Registers a group of players with the online service as being part of the online session Interfaces/OnlineSessionInterface.h  

void RemoveNamedSession ( FName SessionName
)

 Searches the named session array for the specified session and removes it Interfaces/OnlineSessionInterface.h  

virtual void RemovePlayerFromSession ( int32 LocalUserNum,
FName SessionName,
const FUniqueNetId& TargetPlayerId
)

 Removes a player from the session. Interfaces/OnlineSessionInterface.h  

bool SendSessionInviteToFriend ( const FUniqueNetId& LocalUserId,
FName SessionName,
const FUniqueNetId& Friend
)

 Sends an invitation to play in the player's current session Interfaces/OnlineSessionInterface.h  

bool SendSessionInviteToFriend ( int32 LocalUserNum,
FName SessionName,
const FUniqueNetId& Friend
)

 Sends an invitation to play in the player's current session Interfaces/OnlineSessionInterface.h  

bool SendSessionInviteToFriends ( int32 LocalUserNum,
FName SessionName,
const TArray< FUniqueNetIdRef >& Friends
)

 Sends invitations to play in the player's current session Interfaces/OnlineSessionInterface.h  

bool SendSessionInviteToFriends ( const FUniqueNetId& LocalUserId,
FName SessionName,
const TArray< FUniqueNetIdRef >& Friends
)

 Sends invitations to play in the player's current session Interfaces/OnlineSessionInterface.h  

bool StartMatchmaking ( const TArray< FUniqueNetIdRef >& LocalPlayers,
FName SessionName,
const FOnlineSessionSettings& NewSessionSettings,
TSharedRef< FOnlineSessionSearch >& SearchSettings
)

 Begins cloud based matchmaking for a session Interfaces/OnlineSessionInterface.h  

virtual bool StartMatchmaking ( const TArray< FSessionMatchmakingUser >& LocalPlayers,
FName SessionName,
const FOnlineSessionSettings& NewSessionSettings,
TSharedRef< FOnlineSessionSearch >& SearchSettings,
const FOnStartMatchmakingComplete& CompletionDelegate
)

 Begins cloud based matchmaking for a session Interfaces/OnlineSessionInterface.h  

bool StartSession ( FName SessionName
)

 Marks an online session as in progress (as opposed to being in lobby or pending) Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnCancelFindSessionsCompleteDelegates ( bool Param1
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnCancelMatchmakingCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnCreateSessionCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnDestroySessionCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnDestroySessionRequestedDelegates ( int32 Param1,
FName Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnEndSessionCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnFindFriendSessionCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const TArray< FOnlineSessionSearchResult >& Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnFindSessionsCompleteDelegates ( bool Param1
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnJoinSessionCompleteDelegates ( FName Param1,
EOnJoinSessionCompleteResult::Type Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnMatchmakingCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnPingSearchResultsCompleteDelegates ( bool Param1
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnQosDataRequestedDelegates ( FName Param1
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnRegisterPlayersCompleteDelegates ( FName Param1,
const TArray< FUniqueNetIdRef >& Param2,
bool Param3
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionFailureDelegates ( const FUniqueNetId& Param1,
ESessionFailure::Type Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionInviteReceivedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FOnlineSessionSearchResult& Param4
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionParticipantJoinedDelegates ( FName Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionParticipantLeftDelegates ( FName Param1,
const FUniqueNetId& Param2,
EOnSessionParticipantLeftReason Param3
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionParticipantSettingsUpdatedDelegates ( FName Param1,
const FUniqueNetId& Param2,
const FOnlineSessionSettings& Param3
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionSettingsUpdatedDelegates ( FName Param1,
const FOnlineSessionSettings& Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnSessionUserInviteAcceptedDelegates ( const bool Param1,
const int32 Param2,
FUniqueNetIdPtr Param3,
const FOnlineSessionSearchResult& Param4
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnStartSessionCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnUnregisterPlayersCompleteDelegates ( FName Param1,
const TArray< FUniqueNetIdRef >& Param2,
bool Param3
)

   Interfaces/OnlineSessionInterface.h  

virtual void TriggerOnUpdateSessionCompleteDelegates ( FName Param1,
bool Param2
)

   Interfaces/OnlineSessionInterface.h  

void UnregisterLocalPlayer ( const FUniqueNetId& PlayerId,
FName SessionName,
const FOnUnregisterLocalPlayerCompleteDelegate& Delegate
)

 Unregisters a local player with a session. Interfaces/OnlineSessionInterface.h  

bool UnregisterPlayer ( FName SessionName,
const FUniqueNetId& PlayerId
)

 Unregisters a player with the online service as being part of the online session Interfaces/OnlineSessionInterface.h  

bool UnregisterPlayers ( FName SessionName,
const TArray< FUniqueNetIdRef >& Players
)

 Unregisters a group of players with the online service as being part of the online session Interfaces/OnlineSessionInterface.h  

bool UpdateSession ( FName SessionName,
FOnlineSessionSettings& UpdatedSessionSettings,
bool bShouldRefreshOnlineData
)

 Updates the localized settings/properties for the session in question Interfaces/OnlineSessionInterface.h  

Protected

Name Remarks Include Path Unreal Specifiers

FNamedOnlineSession * AddNamedSession ( FName SessionName,
const FOnlineSession& Session
)

 Adds a new named session to the list (from existing session data) Interfaces/OnlineSessionInterface.h  

FNamedOnlineSession * AddNamedSession ( FName SessionName,
const FOnlineSessionSettings& SessionSettings
)

 Adds a new named session to the list (new session) Interfaces/OnlineSessionInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page