Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces
References
| Module | OnlineSubsystem |
| Header | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineExternalUIInterface.h |
| Include | #include "Interfaces/OnlineExternalUIInterface.h" |
Syntax
class IOnlineExternalUI
Remarks
Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FOnCreateAccountFlowUIRequired | OnCreateAccountFlowUIRequiredDelegates | Delegate called when the online subsystem requires an external UI to handle account creation |
 |
FOnExternalUIChange | OnExternalUIChangeDelegates | Delegate called when the external UI is opened or closed |
 |
FOnLoginFlowUIRequired | OnLoginFlowUIRequiredDelegates | Delegate called when the online subsystem requires an external UI to handle login flow |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FDelegateHandle | ||
  |
FDelegateHandle | AddOnExternalUIChangeDelegate_Handle
(
const FOnExternalUIChangeDelegate& Delegate |
|
  |
FDelegateHandle | AddOnLoginFlowUIRequiredDelegate_Handle
(
const FOnLoginFlowUIRequiredDelegate& Delegate |
|
  |
void | ||
  |
void | ClearOnCreateAccountFlowUIRequiredDelegates
(
void* Object |
|
  |
void | ||
  |
void | ClearOnExternalUIChangeDelegates
(
void* Object |
|
  |
void | ||
  |
void | ClearOnLoginFlowUIRequiredDelegates
(
void* Object |
|
 |
bool | CloseWebURL () |
Closes the currently active web external UI |
  |
void | Tell the system that you've entered into a screen considered in-game store. | |
  |
void | Tell the system that you've entered into a screen considered in-game store. | |
 |
bool | ShowAccountCreationUI
(
const int ControllerIndex, |
Displays the UI that prompts the user to create an account |
 |
bool | ShowAccountUpgradeUI
(
const FUniqueNetId& UniqueId |
Displays a system dialog to purchase user account upgrades. |
 |
bool | ShowAchievementsUI
(
int32 LocalUserNum |
Displays the UI that shows a user's list of achievements |
 |
bool | ShowFriendsUI
(
int32 LocalUserNum |
Displays the UI that shows a user's list of friends |
 |
bool | ShowInviteUI
(
int32 LocalUserNum, |
Displays the UI that shows a user's list of friends to invite |
 |
bool | ShowLeaderboardUI
(
const FString& LeaderboardName |
Displays the UI that shows a specific leaderboard |
 |
bool | ShowLoginUI
(
const int ControllerIndex, |
Displays the UI that prompts the user for their login credentials. |
  |
bool | ShowPlatformMessageBox
(
const FUniqueNetId& UserId, |
Displays an informational system dialog. |
 |
bool | ShowProfileUI
(
const FUniqueNetId& Requestor, |
Displays a user's profile card. |
  |
bool | ShowSendMessageToUserUI
(
int32 LocalUserNum, |
Display the platform UI for sending a mailbox message to the specified user. |
 |
bool | ShowSendMessageUI
(
int32 LocalUserNum, |
Display the platform UI for sending a mailbox message to another user |
 |
bool | ShowStoreUI
(
int32 LocalUserNum, |
Display the platform UI for browsing available products for purchase |
 |
bool | ShowWebURL
(
const FString& Url, |
Displays a web page in the external UI |
  |
void | TriggerOnCreateAccountFlowUIRequiredDelegates
(
const FString& Param1, |
|
  |
void | TriggerOnExternalUIChangeDelegates
(
bool Param1 |
|
  |
void | TriggerOnLoginFlowUIRequiredDelegates
(
const FString& Param1, |