Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface
| Name | ISessions |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Sessions.h |
| Include Path | #include "Online/Sessions.h" |
Syntax
class ISessions
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| 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 | Online/Sessions.h | ||
| Clears the presence session for the given user. | Online/Sessions.h | ||
TOnlineAsyncOpHandle< FCreateSession > CreateSession
(
FCreateSession::Params&& Params |
Creates a new session with the given parameters, and assigns to it the given local name. | Online/Sessions.h | |
TOnlineAsyncOpHandle< FFindSessions > FindSessions
(
FFindSessions::Params&& Params |
Queries the API session service for sessions matching the given parameters. | Online/Sessions.h | |
TOnlineResult< FGetAllSessionInvites > GetAllSessionInvites
(
FGetAllSessionInvites::Params&& Params |
Gets an array of references to all the session invites the given user has received. | Online/Sessions.h | |
TOnlineResult< FGetAllSessions > GetAllSessions
(
FGetAllSessions::Params&& Params |
Gets an array of references to all the sessions the given user is part of. | Online/Sessions.h | |
TOnlineResult< FGetPresenceSession > GetPresenceSession
(
FGetPresenceSession::Params&& Params |
Gets a reference to the session set as presence session for the given user. | Online/Sessions.h | |
TOnlineResult< FGetSessionById > GetSessionById
(
FGetSessionById::Params&& Params |
Gets a reference to the session with the given id handle. | Online/Sessions.h | |
TOnlineResult< FGetSessionByName > GetSessionByName
(
FGetSessionByName::Params&& Params |
Gets a reference to the session with the given local name. | Online/Sessions.h | |
TOnlineResult< FGetSessionInviteById > GetSessionInviteById
(
FGetSessionInviteById::Params&& Params |
Gets a reference to the session invite with the given invite id. | Online/Sessions.h | |
TOnlineResult< FGetSessionName > GetSessionName
(
FGetSessionName::Params&& Params |
Gets the name of the session with the given id handle. | Online/Sessions.h | |
TOnlineResult< FIsPresenceSession > IsPresenceSession
(
FIsPresenceSession::Params&& Params |
Returns whether the session with the given id is set as the presence session for the given user. | Online/Sessions.h | |
TOnlineAsyncOpHandle< FJoinSession > JoinSession
(
FJoinSession::Params&& Params |
Joins the session with the given session id, and assigns to it the given local name. | Online/Sessions.h | |
TOnlineAsyncOpHandle< FLeaveSession > LeaveSession
(
FLeaveSession::Params&& Params |
Leaves and optionally destroys the session with the given name. | Online/Sessions.h | |
TOnlineEvent< void(const FSessionCreated &)> OnSessionCreated() |
This event will trigger as a result of a session being created. | Online/Sessions.h | |
TOnlineEvent< void(const FSessionInviteReceived &)> OnSessionInviteReceived() |
This event will trigger as a result of receiving a session invite. | Online/Sessions.h | |
TOnlineEvent< void(const FSessionJoined &)> OnSessionJoined() |
This event will trigger as a result of joining a session. | Online/Sessions.h | |
TOnlineEvent< void(const FSessionLeft &)> OnSessionLeft() |
This event will trigger as a result of leaving or destroying a session. | Online/Sessions.h | |
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. | Online/Sessions.h | |
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. | Online/Sessions.h | |
TOnlineAsyncOpHandle< FRejectSessionInvite > RejectSessionInvite
(
FRejectSessionInvite::Params&& Params |
Rejects the session invite with the given invite id. | Online/Sessions.h | |
| Removes the given user from the session with the given name The number of open slots in the session will increase accordingly | Online/Sessions.h | ||
TOnlineAsyncOpHandle< FSendSessionInvite > SendSessionInvite
(
FSendSessionInvite::Params&& Params |
Sends an invite to the session with the given name to all given users. | Online/Sessions.h | |
| Sets the session with the given id as the presence session for the given user. | Online/Sessions.h | ||
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. | Online/Sessions.h | |
| Update the settings for the session with the given name. | Online/Sessions.h |