Platform Namespace Reference

Functions
Platform|LocalNotification
void	GetLaunchNotification (bool &NotificationLaunchedApp, FString &ActivationEvent, int &FireDate)
	Get the local notification that was used to launch the app.
void	CancelLocalNotificationById (int NotificationId)
	Cancel a local notification given the ActivationEvent.
void	ClearAllLocalNotifications ()
	Clear all pending local notifications. Typically this will be done before scheduling new notifications when going into the background.
EScreenOrientation	GetAllowedDeviceOrientation ()
	Returns the allowed orientation of the device. This is NOT the same as GetDeviceOrientation, which only returns Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight. The allowed orientation limits what orientation your device can have. So if you set the allowed orientation to LandscapeLeft, GetDeviceOrientation will only ever return LandscapeLeft. But if you set the allowed orientation to LandscapeSensor, you are actually restricting the allowed orientations to LandscapeLeft OR LandscapeRight (depending on the sensor), so GetDeviceOrientation might return LandscapeLeft OR LandscapeRight.
EScreenOrientation	GetDeviceOrientation ()
	Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight.
void	CancelLocalNotification (FString ActivationEvent)
	Cancel a local notification given the ActivationEvent.
int	ScheduleLocalNotificationAtTime (FDateTime FireDateTime, bool LocalTime, FText Title, FText Body, FText Action, FString ActivationEvent)
	Schedule a local notification at a specific time, inLocalTime specifies the current local time or if UTC time should be used.
int	ScheduleLocalNotificationBadgeAtTime (FDateTime FireDateTime, bool LocalTime, FString ActivationEvent)
	Schedule a local notification badge at a specific time, inLocalTime specifies the current local time or if UTC time should be used.
void	ScheduleLocalNotificationBadgeFromNow (int inSecondsFromNow, FString ActivationEvent)
	Schedule a local notification badge to fire inSecondsFromNow from now.
int	ScheduleLocalNotificationFromNow (int inSecondsFromNow, FText Title, FText Body, FText Action, FString ActivationEvent)
	Schedule a local notification to fire inSecondsFromNow from now.
void	SetAllowedDeviceOrientation (EScreenOrientation NewAllowedDeviceOrientation)
	Set the allowed orientation of the device.

Variables
Variables
const EScreenOrientation	DeviceOrientation
EScreenOrientation	AllowedDeviceOrientation

Function Documentation

CancelLocalNotification()

void CancelLocalNotification

(

FString

ActivationEvent

)

Cancel a local notification given the ActivationEvent.

Parameters

ActivationEvent

The string passed into the Schedule call for the notification to be cancelled

CancelLocalNotificationById()

void CancelLocalNotificationById

(

int

NotificationId

)

Cancel a local notification given the ActivationEvent.

Parameters

NotificationId

The Id returned from one of the ScheduleLocalNotification* functions

ClearAllLocalNotifications()

void ClearAllLocalNotifications

(

)

Clear all pending local notifications. Typically this will be done before scheduling new notifications when going into the background.

GetAllowedDeviceOrientation()

EScreenOrientation GetAllowedDeviceOrientation

(

)

Returns the allowed orientation of the device. This is NOT the same as GetDeviceOrientation, which only returns Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight. The allowed orientation limits what orientation your device can have. So if you set the allowed orientation to LandscapeLeft, GetDeviceOrientation will only ever return LandscapeLeft. But if you set the allowed orientation to LandscapeSensor, you are actually restricting the allowed orientations to LandscapeLeft OR LandscapeRight (depending on the sensor), so GetDeviceOrientation might return LandscapeLeft OR LandscapeRight.

Returns

An EDeviceScreenOrientation value.

GetDeviceOrientation()

EScreenOrientation GetDeviceOrientation

(

)

Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight.

Returns

An EDeviceScreenOrientation value.

GetLaunchNotification()

void GetLaunchNotification	(	bool &	NotificationLaunchedApp,
		FString &	ActivationEvent,
		int &	FireDate )

Get the local notification that was used to launch the app.

Parameters

NotificationLaunchedApp	Return true if a notification was used to launch the app
ActivationEvent	Returns the name of the ActivationEvent if a notification was used to launch the app
FireDate	Returns the time the notification was activated

ScheduleLocalNotificationAtTime()

int ScheduleLocalNotificationAtTime	(	FDateTime	FireDateTime,
		bool	LocalTime,
		FText	Title,
		FText	Body,
		FText	Action,
		FString	ActivationEvent )

Schedule a local notification at a specific time, inLocalTime specifies the current local time or if UTC time should be used.

Parameters

FireDateTime	The time at which to fire the local notification
LocalTime	If true the provided time is in the local timezone, if false it is in UTC
Title	The title of the notification
Body	The more detailed description of the notification
Action	The text to be displayed on the slider controller
ActivationEvent	A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification

ScheduleLocalNotificationBadgeAtTime()

int ScheduleLocalNotificationBadgeAtTime	(	FDateTime	FireDateTime,
		bool	LocalTime,
		FString	ActivationEvent )

Schedule a local notification badge at a specific time, inLocalTime specifies the current local time or if UTC time should be used.

Parameters

FireDateTime	The time at which to fire the local notification
LocalTime	If true the provided time is in the local timezone, if false it is in UTC
ActivationEvent	A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification

ScheduleLocalNotificationBadgeFromNow()

void ScheduleLocalNotificationBadgeFromNow	(	int	inSecondsFromNow,
		FString	ActivationEvent )

Schedule a local notification badge to fire inSecondsFromNow from now.

Parameters

inSecondsFromNow	The seconds until the notification should fire
ActivationEvent	A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification

ScheduleLocalNotificationFromNow()

int ScheduleLocalNotificationFromNow	(	int	inSecondsFromNow,
		FText	Title,
		FText	Body,
		FText	Action,
		FString	ActivationEvent )

Schedule a local notification to fire inSecondsFromNow from now.

Parameters

inSecondsFromNow	The seconds until the notification should fire
Title	The title of the notification
Body	The more detailed description of the notification
Action	The text to be displayed on the slider controller
ActivationEvent	A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification

SetAllowedDeviceOrientation()

void SetAllowedDeviceOrientation

(

EScreenOrientation

NewAllowedDeviceOrientation

)

Set the allowed orientation of the device.

Variable Documentation

AllowedDeviceOrientation

EScreenOrientation AllowedDeviceOrientation

DeviceOrientation

const EScreenOrientation DeviceOrientation