Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.OnlineAccountInterface

Modifiers
dependson ( OnlineSubsystem )

This interface provides account creation and enumeration functions

Engine.OnlineAccountInterface

Delegates Summary
delegate OnCreateOnlineAccountCompleted (EOnlineAccountCreateStatus ErrorStatus)

Functions Summary
function AddCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)
function ClearCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)
functionbool CreateLocalAccount (string UserName, ptional string Password)
functionbool CreateOnlineAccount (string UserName, tring Password, tring EmailAddress, ptional string ProductKey)
functionbool DeleteLocalAccount (string UserName, ptional string Password)
functionbool GetLocalAccountNames (out array<string> Accounts)
functionbool IsKeyValid ()
functionbool RenameLocalAccount (string NewUserName, tring OldUserName, ptional string Password)
functionbool SaveKey (string ProductKey)


Delegates Detail

OnCreateOnlineAccountCompleted Source code

delegate OnCreateOnlineAccountCompleted ( EOnlineAccountCreateStatus ErrorStatus )
Delegate used in notifying the UI/game that the account creation completed
@param ErrorStatus whether the account created successfully or not


Functions Detail

AddCreateOnlineAccountCompletedDelegate Source code

function AddCreateOnlineAccountCompletedDelegate ( delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate )
Sets the delegate used to notify the gameplay code that account creation completed
@param AccountCreateDelegate the delegate to use for notifications

ClearCreateOnlineAccountCompletedDelegate Source code

function ClearCreateOnlineAccountCompletedDelegate ( delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate )
Removes the specified delegate from the notification list
@param AccountCreateDelegate the delegate to use for notifications

CreateLocalAccount Source code

function bool CreateLocalAccount ( string UserName,optional string Password )
Creates a non-networked account on the local system. Password is only used when supplied. Otherwise the account is not secured.
@param UserName the unique nickname of the account
@param Password the password securing the account
@return true if the account was created, false otherwise

CreateOnlineAccount Source code

function bool CreateOnlineAccount ( string UserName,string Password,string EmailAddress,optional string ProductKey )
Creates a network enabled account on the online service
@param UserName the unique nickname of the account
@param Password the password securing the account
@param EmailAddress the address used to send password hints to
@param ProductKey the unique id for this installed product
@return true if the account was created, false otherwise

DeleteLocalAccount Source code

function bool DeleteLocalAccount ( string UserName,optional string Password )
Deletes a local account if the password matches
@param UserName the unique nickname of the account
@param Password the password securing the account
@return true if the account was deleted, false otherwise

GetLocalAccountNames Source code

function bool GetLocalAccountNames ( out array<string> Accounts )
Fetches a list of local accounts
@param Accounts the array that is populated with the accounts
@return true if the list was read, false otherwise

IsKeyValid Source code

function bool IsKeyValid ( )

@return true if the product key is valid, false if it is invalid

RenameLocalAccount Source code

function bool RenameLocalAccount ( string NewUserName,string OldUserName,optional string Password )
Changes the name of a local account
@param UserName the unique nickname of the account
@param Password the password securing the account
@return true if the account was renamed, false otherwise

SaveKey Source code

function bool SaveKey ( string ProductKey )
Saves the product key
@param ProductKey the product key the user entered
@return true if the key was stored successfully, false otherwise


Defaultproperties

defaultproperties
{
   Name="Default__OnlineAccountInterface"
   ObjectArchetype=Interface'Core.Default__Interface'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:40.063 - Created with UnCodeX