Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface
| Name | IAuth |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Auth.h |
| Include Path | #include "Online/Auth.h" |
Syntax
class IAuth
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Starts a verified auth session for a remote user. | Online/Auth.h | ||
| Cancels the ticket associated with a verified auth session. | Online/Auth.h | ||
TOnlineAsyncOpHandle< FAuthCreateAccount > CreateAccount
(
FAuthCreateAccount::Params&& Params |
Create a new account and link it to an external auth method using a continuation token from a previous login attempt. | Online/Auth.h | |
TOnlineAsyncOpHandle< FAuthEndVerifiedAuthSession > EndVerifiedAuthSession
(
FAuthEndVerifiedAuthSession::Params&& Params |
Clean up the remote verified auth session and handle any required book-keeping. | Online/Auth.h | |
TOnlineResult< FAuthGetAllLocalOnlineUsers > GetAllLocalOnlineUsers
(
FAuthGetAllLocalOnlineUsers::Params&& Params |
Retrieve all logged in user accounts. | Online/Auth.h | |
TOnlineResult< FAuthGetLinkAccountContinuationId > GetLinkAccountContinuationId
(
FAuthGetLinkAccountContinuationId::Params&& Params |
Retrieve the continuation id from a previous login attempt which used an external auth token and failed with Errors::InvalidUser. | Online/Auth.h | |
TOnlineResult< FAuthGetLocalOnlineUserByOnlineAccountId > GetLocalOnlineUserByOnlineAccountId
(
FAuthGetLocalOnlineUserByOnlineAccountId::Params&& Params |
Retrieve a logged in user account. | Online/Auth.h | |
TOnlineResult< FAuthGetLocalOnlineUserByPlatformUserId > GetLocalOnlineUserByPlatformUserId
(
FAuthGetLocalOnlineUserByPlatformUserId::Params&& Params |
Retrieve a logged in user account. | Online/Auth.h | |
TOnlineResult< FAuthGetRelyingParty > GetRelyingParty
(
FAuthGetRelyingParty::Params&& Params |
Retrieve the relying party to use when fetching an external token to authenticate with this interface. | Online/Auth.h | |
bool IsLoggedIn
(
const FAccountId& AccountId |
Helper for querying the login status of a local user. | Online/Auth.h | |
bool IsLoggedIn
(
const FPlatformUserId& PlatformUserId |
Helper for querying the login status of a local user by platform user id. | Online/Auth.h | |
TOnlineAsyncOpHandle< FAuthLinkAccount > LinkAccount
(
FAuthLinkAccount::Params&& Params |
Link a logged in account to an external auth method using a continuation token from a previous login attempt. | Online/Auth.h | |
TOnlineAsyncOpHandle< FAuthLogin > Login
(
FAuthLogin::Params&& Params |
Authenticate a local user. | Online/Auth.h | |
TOnlineAsyncOpHandle< FAuthLogout > Logout
(
FAuthLogout::Params&& Params |
Concludes the auth session for the local user. | Online/Auth.h | |
| Modify attributes associated with an authenticated account. | Online/Auth.h | ||
TOnlineEvent< void(const FAuthAccountAttributesChanged &)> OnAccountAttributesChanged() |
Triggered when the additional attributes associated with an authenticated account are changed. | Online/Auth.h | |
TOnlineEvent< void(const FAuthLoginStatusChanged &)> OnLoginStatusChanged() |
Triggered when the login status for a logged in user changes. | Online/Auth.h | |
TOnlineEvent< void(const FAuthPendingAuthExpiration &)> OnPendingAuthExpiration () |
Triggered when the auth token will expire soon. | Online/Auth.h | |
| Retrieves a token appropriate for linking the service account with a service account of a different service type. | Online/Auth.h | ||
| Queries a ticket which is appropriate for making server-to-server calls on behalf of the signed in user. | Online/Auth.h | ||
| Retrieves a ticket which is used to create a verified authentication session on a remote client. | Online/Auth.h |