Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface > API/Plugins/OnlineServicesInterface/Online
References
| Module | OnlineServicesInterface |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Auth.h |
| Include | #include "Online/Auth.h" |
Syntax
class IAuth
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TOnlineAsyncOpHandle< FAuthBeginVerifiedAuthSession > | Starts a verified auth session for a remote user. | |
 |
TOnlineAsyncOpHandle< FAuthCancelVerifiedAuthTicket > | Cancels the ticket associated with a verified auth session. | |
 |
TOnlineAsyncOpHandle< FAuthEndVerifiedAuthSession > | Clean up the remote verified auth session and handle any required book-keeping. | |
  |
TOnlineResult< FAuthGetAllLocalOnlineUsers > | Retrieve all logged in user accounts. | |
  |
TOnlineResult< FAuthGetLocalOnlineUserByOnlineAccountId > | Retrieve a logged in user account. | |
  |
TOnlineResult< FAuthGetLocalOnlineUserByPlatformUserId > | Retrieve a logged in user account. | |
  |
bool | IsLoggedIn
(
const FAccountId& AccountId |
Helper for querying the login status of a local user. |
 |
TOnlineAsyncOpHandle< FAuthLogin > | Login
(
FAuthLogin::Params&& Params |
Authenticate a local user. |
 |
TOnlineAsyncOpHandle< FAuthLogout > | Logout
(
FAuthLogout::Params&& Params |
Concludes the auth session for the local user. |
 |
TOnlineAsyncOpHandle< FAuthModifyAccountAttributes > | Modify attributes associated with an authenticated account. | |
 |
TOnlineEvent< void(const FAuthAccountAttributesChanged &)> | Triggered when the additional attributes associated with an authenticated account are changed. | |
 |
TOnlineEvent< void(const FAuthLoginStatusChanged &)> | Triggered when the login status for a logged in user changes. | |
 |
TOnlineEvent< void(const FAuthPendingAuthExpiration &)> | Triggered when the auth token will expire soon. | |
 |
TOnlineAsyncOpHandle< FAuthQueryExternalAuthToken > | Retrieves a token appropriate for linking the service account with a service account of a different service type. | |
 |
TOnlineAsyncOpHandle< FAuthQueryExternalServerAuthTicket > | Queries a ticket which is appropriate for making server-to-server calls on behalf of the signed in user. | |
 |
TOnlineAsyncOpHandle< FAuthQueryVerifiedAuthTicket > | Retrieves a ticket which is used to create a verified authentication session on a remote client. |