PICO Unreal Platform SDK
FApplicationLifecycleInterface Class Reference

Pico Application interface class. More...

#include <ApplicationLifecycleInterface.h>

Public Member Functions

bool GetLaunchDetails (FLaunchDetails &OutLaunchDetails)
 Gets information about how the app was launched. More...
 
bool LogDeeplinkResult (const FString &TrackingID, ELaunchResult LaunchResult)
 Logs whether the user has been successfully directed to the desired destination via a deep link. More...
 
bool GetSystemInfo (FPicoSystemInfo &SystemInfo)
 Get device system information synchronously. More...
 

Public Attributes

FApplicationLifecycleStringResult LaunchIntentChangedCallback
 Gets notified when the launch intent has been changed.
 

Detailed Description

Pico Application interface class.

Member Function Documentation

◆ GetLaunchDetails()

bool GetLaunchDetails ( FLaunchDetails OutLaunchDetails)

Gets information about how the app was launched.

Parameters
OutLaunchDetailsThe [out] struct of launch details.
Returns
Bool:
  • true: Call success
  • false: Call failure

◆ GetSystemInfo()

bool GetSystemInfo ( FPicoSystemInfo SystemInfo)

Get device system information synchronously.

Parameters
SystemInfoThe [out] struct of system info:
  • ROMVersion: The ROM version of the device system
  • Locale: The region of the device system
  • ProductName: The product name of the device system
  • bIsCnDevice: Whether the device system is global or in mainland China
  • MatrixVersionName: The matrix version name of the device system
  • MatrixVersionCode: The matrix version code of the device system
Returns
Bool:
  • true: Call success
  • false: Call failure

◆ LogDeeplinkResult()

bool LogDeeplinkResult ( const FString &  TrackingID,
ELaunchResult  LaunchResult 
)

Logs whether the user has been successfully directed to the desired destination via a deep link.

Parameters
TrackingIDThe tracking ID of the app launch event.
LaunchResultEnumerations of the launch result:
  • Unknown
  • Success
  • FailedRoomFull
  • FailedGameAlreadyStarted
  • FailedRoomNotFound
  • FailedUserDeclined
  • FailedOtherReason
Returns
Bool:
  • true: Call success
  • false: Call failure