FSessionsCommon


Module	OnlineServicesCommon
Header	/Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/SessionsCommon.h
Include	#include "Online/SessionsCommon.h"

Type	Name	Description
TMap< FOnlineSessionId, TSharedRef< FSessionCommon > >	AllSessionsById	Set of every distinct FSession found, indexed by Id
TMap< FAccountId, TPromise< TOnlineResult< FFindSessions > > >	CurrentSessionSearchPromisesUserMap	Handle for an ongoing session search operation, mapped per user
TMap< FName, FOnlineSessionId >	LocalSessionsByName	Map of sessions that local users are part of, indexed by their local name
TMap< FAccountId, TArray< FName > >	NamedSessionUserMap	Map of named sessions a user is part of, indexed by user
TMap< FAccountId, FOnlineSessionId >	PresenceSessionsUserMap	Map of sessions that local users have set as their presence session to appear in the platform UI.
TMap< FAccountId, TArray< FOnlineSessionId > >	SearchResultsUserMap	Cache for the last set of session search results, mapped per user
UE::Online::FSessionsCommon::FSessionEvents	SessionEvents
TMap< FAccountId, TMap< FSessionInviteId, TSharedRef< FSessionInviteCommon > > >	SessionInvitesUserMap	Cache for received session invites, mapped per user

	Type	Name	Description
		FSessionsCommon ( FOnlineServicesCommon& InServices )	FSessionsCommon

Type	Name	Description
void	AddSearchResult ( const TSharedRef< FSessionCommon > Session, const FAccountId& LocalAccountId )
void	AddSessionInvite ( const TSharedRef< FSessionInviteCommon > SessionInvite, const TSharedRef< FSessionCommon > Session, const FAccountId& LocalAccountId )
TOnlineAsyncOpHandle< FAddSessionMember >	AddSessionMember ( FAddSessionMember::Params&& Params )	Adds the given user as a new session member to the session with the given name The number of open slots in the session will decrease accordingly
TFuture< TOnlineResult< FAddSessionMember > >	AddSessionMemberImpl ( const FAddSessionMember::Params& Params )
TOnlineResult< FAddSessionMember >	AddSessionMemberInternal ( const FAddSessionMember::Params& Params )
void	AddSessionReferences ( const FOnlineSessionId SessionId, const FName& SessionName, const FAccountId& LocalAccountId, bool bIsPresenceSession )
void	AddSessionWithReferences ( const TSharedRef< FSessionCommon > Session, const FName& SessionName, const FAccountId& LocalAccountId, bool bIsPresenceSession )
FSessionUpdate	BuildSessionUpdate ( const TSharedRef< FSessionCommon >& Session, const FSessionSettingsUpdate& UpdatedValues )
TOptional< FOnlineError >	CheckParams ( const FRemoveSessionMember::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FAddSessionMember::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FCreateSession::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FJoinSession::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FUpdateSessionSettings::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FFindSessions::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FLeaveSession::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FRejectSessionInvite::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FStartMatchmaking::Params& Params )
TOptional< FOnlineError >	CheckParams ( const FSendSessionInvite::Params& Params )
TOptional< FOnlineError >	CheckState ( const FLeaveSession::Params& Params )
TOptional< FOnlineError >	CheckState ( const FUpdateSessionSettings::Params& Params )
TOptional< FOnlineError >	CheckState ( const FFindSessions::Params& Params )
TOptional< FOnlineError >	CheckState ( const FStartMatchmaking::Params& Params )
TOptional< FOnlineError >	CheckState ( const FJoinSession::Params& Params )
TOptional< FOnlineError >	CheckState ( const FAddSessionMember::Params& Params )
TOptional< FOnlineError >	CheckState ( const FRemoveSessionMember::Params& Params )
TOptional< FOnlineError >	CheckState ( const FCreateSession::Params& Params )
TOptional< FOnlineError >	CheckState ( const FSendSessionInvite::Params& Params )
TOptional< FOnlineError >	CheckState ( const FRejectSessionInvite::Params& Params )
TOnlineResult< FClearPresenceSession >	ClearPresenceSession ( FClearPresenceSession::Params&& Params )	Clears the presence session for the given user.
TOnlineResult< FClearPresenceSession >	ClearPresenceSessionImpl ( FClearPresenceSession::Params&& Params )
void	ClearSessionInvitesForSession ( const FAccountId& LocalAccountId, const FOnlineSessionId SessionId )
void	ClearSessionReferences ( const FOnlineSessionId SessionId, const FName& SessionName, const FAccountId& LocalAccountId )
TOnlineAsyncOpHandle< FCreateSession >	CreateSession ( FCreateSession::Params&& Params )	Creates a new session with the given parameters, and assigns to it the given local name.
TFuture< TOnlineResult< FCreateSession > >	CreateSessionImpl ( const FCreateSession::Params& Params )
TOnlineAsyncOpHandle< FFindSessions >	FindSessions ( FFindSessions::Params&& Params )	Queries the API session service for sessions matching the given parameters.
TFuture< TOnlineResult< FFindSessions > >	FindSessionsImpl ( const FFindSessions::Params& Params )
TOnlineResult< FGetAllSessionInvites >	GetAllSessionInvites ( FGetAllSessionInvites::Params&& Params )	Gets an array of references to all the session invites the given user has received.
TOnlineResult< FGetAllSessions >	GetAllSessions ( FGetAllSessions::Params&& Params )	ISessions.
TOnlineResult< FGetMutableSessionById >	GetMutableSessionById ( FGetMutableSessionById::Params&& Params )
TOnlineResult< FGetMutableSessionByName >	GetMutableSessionByName ( FGetMutableSessionByName::Params&& Params )	Auxiliary methods.
TOnlineResult< FGetPresenceSession >	GetPresenceSession ( FGetPresenceSession::Params&& Params )	Gets a reference to the session set as presence session for the given user.
TOnlineResult< FGetSessionById >	GetSessionById ( FGetSessionById::Params&& Params )	Gets a reference to the session with the given id handle.
TOnlineResult< FGetSessionByName >	GetSessionByName ( FGetSessionByName::Params&& Params )	Gets a reference to the session with the given local name.
TOnlineResult< FGetSessionInviteById >	GetSessionInviteById ( FGetSessionInviteById::Params&& Params )	Gets a reference to the session invite with the given invite id.
TOnlineResult< FIsPresenceSession >	IsPresenceSession ( FIsPresenceSession::Params&& Params )	Returns whether the session with the given id is set as the presence session for the given user.
TOnlineAsyncOpHandle< FJoinSession >	JoinSession ( FJoinSession::Params&& Params )	Joins the session with the given session id, and assigns to it the given local name.
TFuture< TOnlineResult< FJoinSession > >	JoinSessionImpl ( const FJoinSession::Params& Params )
TOnlineAsyncOpHandle< FLeaveSession >	LeaveSession ( FLeaveSession::Params&& Params )	Leaves and optionally destroys the session with the given name.
TFuture< TOnlineResult< FLeaveSession > >	LeaveSessionImpl ( const FLeaveSession::Params& Params )
TOnlineEvent< void(const FSessionInviteReceived &)>	OnSessionInviteReceived ()	This event will trigger as a result of receiving a session invite.
TOnlineEvent< void(const FSessionJoined &)>	OnSessionJoined ()	This event will trigger as a result of joining a session.
TOnlineEvent< void(const FSessionLeft &)>	OnSessionLeft ()	This event will trigger as a result of leaving or destroying a session.
TOnlineEvent< void(const FSessionUpdated &)>	OnSessionUpdated ()	This event will trigger as a result of updating a session's settings, or whenever a session update event is received by the API.
TOnlineEvent< void(const FUISessionJoinRequested &)>	OnUISessionJoinRequested ()	This event will trigger as a result of accepting a session invite or joining a session via the platform UI.
TOnlineAsyncOpHandle< FRejectSessionInvite >	RejectSessionInvite ( FRejectSessionInvite::Params&& Params )	Rejects the session invite with the given invite id.
TFuture< TOnlineResult< FRejectSessionInvite > >	RejectSessionInviteImpl ( const FRejectSessionInvite::Params& Params )
TOnlineAsyncOpHandle< FRemoveSessionMember >	RemoveSessionMember ( FRemoveSessionMember::Params&& Params )	Removes the given user from the session with the given name The number of open slots in the session will increase accordingly
TFuture< TOnlineResult< FRemoveSessionMember > >	RemoveSessionMemberImpl ( const FRemoveSessionMember::Params& Params )
TOnlineResult< FRemoveSessionMember >	RemoveSessionMemberInternal ( const FRemoveSessionMember::Params& Params )
TOnlineAsyncOpHandle< FSendSessionInvite >	SendSessionInvite ( FSendSessionInvite::Params&& Params )	Sends an invite to the session with the given name to all given users.
TFuture< TOnlineResult< FSendSessionInvite > >	SendSessionInviteImpl ( const FSendSessionInvite::Params& Params )
TOnlineResult< FSetPresenceSession >	SetPresenceSession ( FSetPresenceSession::Params&& Params )	Sets the session with the given id as the presence session for the given user.
TOnlineResult< FSetPresenceSession >	SetPresenceSessionImpl ( FSetPresenceSession::Params&& Params )
TOnlineAsyncOpHandle< FStartMatchmaking >	StartMatchmaking ( FStartMatchmaking::Params&& Params )	Starts the matchmaking process, which will either create a session with the given parameters, or join one that matches the given search filters.
TFuture< TOnlineResult< FStartMatchmaking > >	StartMatchmakingImpl ( const FStartMatchmaking::Params& Params )
TOnlineAsyncOpHandle< FUpdateSessionSettings >	UpdateSessionSettings ( FUpdateSessionSettings::Params&& Params )	Update the settings for the session with the given name.
TFuture< TOnlineResult< FUpdateSessionSettings > >	UpdateSessionSettingsImpl ( const FUpdateSessionSettings::Params& Params )