IPortalUserLogin Class Reference

#include <IPortalUserLogin.h>

Inheritance diagram for IPortalUserLogin:

Public Member Functions
virtual TAsyncResult< bool >	PromptUserForSignIn ()=0
virtual	~IPortalUserLogin ()
Public Member Functions inherited from IPortalService
virtual	~IPortalService ()
virtual bool	IsAvailable () const =0

Detailed Description

Interface for the Portal application's user login services. Specializes in actions related to signing a user in and out of the portal.

Constructor & Destructor Documentation

~IPortalUserLogin()

virtual IPortalUserLogin::~IPortalUserLogin ( )

inlinevirtual

Member Function Documentation

PromptUserForSignIn()

virtual TAsyncResult< bool > IPortalUserLogin::PromptUserForSignIn ( )

pure virtual

Requests that the portal come to the front and ask the user to sign-in.

If a user is already signed into the Portal then a prompt may ask the existing user if they want to sign-out, especially if they have on going installations or downloads. The user may opt to not sign-out if this happens.

Returns

whether the portal successfully received and handled your request. Note this doesn't mean that the user signed-in successfully or even that the existing user signed-out. It simply means that the Portal attempted to prompt the user for sign-in.

Implemented in FPortalUserLoginProxy.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Portal/Services/Public/Account/IPortalUserLogin.h