FAuthCommon | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online

Inheritance Hierarchy

References


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

Syntax

class FAuthCommon : public UE::Online::TOnlineComponent< IAuth >

Variables

	Type	Name	Description
	TOnlineEventCallable< void(const FAuthAccountAttributesChanged &)>	OnAuthAccountAttributesChangedEvent
	TOnlineEventCallable< void(const FAuthLoginStatusChanged &)>	OnAuthLoginStatusChangedEvent
	TOnlineEventCallable< void(const FAuthPendingAuthExpiration &)>	OnAuthPendingAuthExpirationEvent

Constructors

	Type	Name	Description
		FAuthCommon ( FOnlineServicesCommon& InServices )

Functions

Type	Name	Description
TOnlineAsyncOpHandle< FAuthBeginVerifiedAuthSession >	BeginVerifiedAuthSession ( FAuthBeginVerifiedAuthSession::Params&& Params )	Starts a verified auth session for a remote user.
TOnlineAsyncOpHandle< FAuthCancelVerifiedAuthTicket >	CancelVerifiedAuthTicket ( FAuthCancelVerifiedAuthTicket::Params&& Params )	Cancels the ticket associated with a verified auth session.
TOnlineAsyncOpHandle< FAuthEndVerifiedAuthSession >	EndVerifiedAuthSession ( FAuthEndVerifiedAuthSession::Params&& Params )	Clean up the remote verified auth session and handle any required book-keeping.
const FAccountInfoRegistry &	GetAccountInfoRegistry ()
TOnlineResult< FAuthGetAllLocalOnlineUsers >	GetAllLocalOnlineUsers ( FAuthGetAllLocalOnlineUsers::Params&& Params )	Retrieve all logged in user accounts.
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.
TOnlineResult< FAuthGetLocalOnlineUserByOnlineAccountId >	GetLocalOnlineUserByOnlineAccountId ( FAuthGetLocalOnlineUserByOnlineAccountId::Params&& Params )	Retrieve a logged in user account.
TOnlineResult< FAuthGetLocalOnlineUserByPlatformUserId >	GetLocalOnlineUserByPlatformUserId ( FAuthGetLocalOnlineUserByPlatformUserId::Params&& Params )	Retrieve a logged in user account.
TOnlineResult< FAuthGetRelyingParty >	GetRelyingParty ( FAuthGetRelyingParty::Params&& Params )	Retrieve the relying party to use when fetching an external token to authenticate with this interface.
bool	IsLoggedIn ( const FAccountId& AccountId )	Helper for querying the login status of a local user.
bool	IsLoggedIn ( const FPlatformUserId& PlatformUserId )	Helper for querying the login status of a local user by platform user id.
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.
TOnlineAsyncOpHandle< FAuthLogin >	Login ( FAuthLogin::Params&& Params )	IAuth.
TOnlineAsyncOpHandle< FAuthLogout >	Logout ( FAuthLogout::Params&& Params )	Concludes the auth session for the local user.
TOnlineAsyncOpHandle< FAuthModifyAccountAttributes >	ModifyAccountAttributes ( FAuthModifyAccountAttributes::Params&& Params )	Modify attributes associated with an authenticated account.
TOnlineEvent< void(const FAuthAccountAttributesChanged &)>	OnAccountAttributesChanged ()	Triggered when the additional attributes associated with an authenticated account are changed.
TOnlineEvent< void(const FAuthLoginStatusChanged &)>	OnLoginStatusChanged ()	Triggered when the login status for a logged in user changes.
TOnlineEvent< void(const FAuthPendingAuthExpiration &)>	OnPendingAuthExpiration ()	Triggered when the auth token will expire soon.
TOnlineAsyncOpHandle< FAuthQueryExternalAuthToken >	QueryExternalAuthToken ( FAuthQueryExternalAuthToken::Params&& Params )	Retrieves a token appropriate for linking the service account with a service account of a different service type.
TOnlineAsyncOpHandle< FAuthQueryExternalServerAuthTicket >	QueryExternalServerAuthTicket ( FAuthQueryExternalServerAuthTicket::Params&& Params )	Queries a ticket which is appropriate for making server-to-server calls on behalf of the signed in user.
TOnlineAsyncOpHandle< FAuthQueryVerifiedAuthTicket >	QueryVerifiedAuthTicket ( FAuthQueryVerifiedAuthTicket::Params&& Params )	Retrieves a ticket which is used to create a verified authentication session on a remote client.