Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface > API/Plugins/OnlineServicesInterface/Online
References
| Module | OnlineServicesInterface |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Sessions.h |
| Include | #include "Online/Sessions.h" |
Syntax
class ISessions
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
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 |
 |
TOnlineResult< FClearPresenceSession > | ClearPresenceSession
(
FClearPresenceSession::Params&& Params |
Clears the presence session for the given user. |
 |
TOnlineAsyncOpHandle< FCreateSession > | CreateSession
(
FCreateSession::Params&& Params |
Creates a new session with the given parameters, and assigns to it the given local name. |
 |
TOnlineAsyncOpHandle< FFindSessions > | FindSessions
(
FFindSessions::Params&& Params |
Queries the API session service for sessions matching the given parameters. |
 |
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 |
Gets an array of references to all the sessions the given user is part of. |
  |
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. |
 |
TOnlineAsyncOpHandle< FLeaveSession > | LeaveSession
(
FLeaveSession::Params&& Params |
Leaves and optionally destroys the session with the given name. |
 |
TOnlineEvent< void(const FSessionInviteReceived &)> | This event will trigger as a result of receiving a session invite. | |
 |
TOnlineEvent< void(const FSessionJoined &)> | This event will trigger as a result of joining a session. | |
 |
TOnlineEvent< void(const FSessionLeft &)> | This event will trigger as a result of leaving or destroying a session. | |
 |
TOnlineEvent< void(const FSessionUpdated &)> | 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 &)> | 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. |
 |
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 |
 |
TOnlineAsyncOpHandle< FSendSessionInvite > | SendSessionInvite
(
FSendSessionInvite::Params&& Params |
Sends an invite to the session with the given name to all given users. |
 |
TOnlineResult< FSetPresenceSession > | SetPresenceSession
(
FSetPresenceSession::Params&& Params |
Sets the session with the given id as the presence session for the given user. |
 |
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. |
 |
TOnlineAsyncOpHandle< FUpdateSessionSettings > | UpdateSessionSettings
(
FUpdateSessionSettings::Params&& Params |
Update the settings for the session with the given name. |