#include <AndroidLocalNotification.h>

Inheritance diagram for FAndroidLocalNotificationService:

Public Member Functions
	FAndroidLocalNotificationService ()

virtual void	ClearAllLocalNotifications ()

virtual int32	ScheduleLocalNotificationAtTime (const FDateTime &FireDateTime, bool LocalTime, const FText &Title, const FText &Body, const FText &Action, const FString &ActivationEvent)

virtual int32	ScheduleLocalNotificationAtTimeOverrideId (const FDateTime &FireDateTime, bool LocalTime, const FText &Title, const FText &Body, const FText &Action, const FString &ActivationEvent, int32 IdOverride)

virtual int32	ScheduleLocalNotificationBadgeAtTime (const FDateTime &FireDateTime, bool LocalTime, const FString &ActivationEvent)

virtual void	GetLaunchNotification (bool &NotificationLaunchedApp, FString &ActivationEvent, int32 &FireDate)

virtual void	SetLaunchNotification (FString const &ActivationEvent, int32 FireDate)

virtual void	CancelLocalNotification (const FString &ActivationEvent)

virtual void	CancelLocalNotification (int NotificationId)

Public Member Functions inherited from ILocalNotificationService
virtual void	CancelLocalNotification (int32 NotificationId)=0

Detailed Description

AndroidLocalNotification implementation of an Unreal local notification service.

Constructor & Destructor Documentation

◆ FAndroidLocalNotificationService()

FAndroidLocalNotificationService::FAndroidLocalNotificationService ( )

Member Function Documentation

◆ CancelLocalNotification() [1/2]

void FAndroidLocalNotificationService::CancelLocalNotification ( const FString & ActivationEvent )

virtual

Cancel a local notification given the ActivationEvent

Parameters

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

Implements ILocalNotificationService.

◆ CancelLocalNotification() [2/2]

virtual void FAndroidLocalNotificationService::CancelLocalNotification ( int NotificationId )

virtual

◆ ClearAllLocalNotifications()

void FAndroidLocalNotificationService::ClearAllLocalNotifications ( )

virtual

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

Implements ILocalNotificationService.

◆ GetLaunchNotification()

void FAndroidLocalNotificationService::GetLaunchNotification	(	bool &	NotificationLaunchedApp,
		FString &	ActivationEvent,
		int32 &	FireDate
	)

virtual

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

Implements ILocalNotificationService.

◆ ScheduleLocalNotificationAtTime()

int32 FAndroidLocalNotificationService::ScheduleLocalNotificationAtTime	(	const FDateTime &	FireDateTime,
		bool	LocalTime,
		const FText &	Title,
		const FText &	Body,
		const FText &	Action,
		const FString &	ActivationEvent
	)

virtual

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

Returns: A unique identifier used to cancel the notification

Implements ILocalNotificationService.

◆ ScheduleLocalNotificationAtTimeOverrideId()

int32 FAndroidLocalNotificationService::ScheduleLocalNotificationAtTimeOverrideId	(	const FDateTime &	FireDateTime,
		bool	LocalTime,
		const FText &	Title,
		const FText &	Body,
		const FText &	Action,
		const FString &	ActivationEvent,
		int32	IdOverride
	)

virtual

Schedule a local notification at a specific time with a specific Id, inLocalTime specifies the current local time or if UTC time should be used Currently only works for Android.

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
IdOverride	A int that is passed to pin the notification to an Id. By doing this it will only show the latest notification sent from that ID.

Returns: A unique identifier used to cancel the notification

Implements ILocalNotificationService.

◆ ScheduleLocalNotificationBadgeAtTime()

int32 FAndroidLocalNotificationService::ScheduleLocalNotificationBadgeAtTime	(	const FDateTime &	FireDateTime,
		bool	LocalTime,
		const FString &	ActivationEvent
	)

virtual

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

Returns: A unique identifier used to cancel the notification

Implements ILocalNotificationService.

◆ SetLaunchNotification()

void FAndroidLocalNotificationService::SetLaunchNotification	(	FString const &	ActivationEvent,
		int32	FireDate
	)

virtual

Set the local notification that was used to launch the app

Parameters

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

Implements ILocalNotificationService.

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

Engine/Source/Runtime/Android/AndroidLocalNotification/Public/AndroidLocalNotification.h
Engine/Source/Runtime/Android/AndroidLocalNotification/Private/AndroidLocalNotification.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FAndroidLocalNotificationService()

Member Function Documentation

◆ CancelLocalNotification() [1/2]

◆ CancelLocalNotification() [2/2]

◆ ClearAllLocalNotifications()

◆ GetLaunchNotification()

◆ ScheduleLocalNotificationAtTime()

◆ ScheduleLocalNotificationAtTimeOverrideId()

◆ ScheduleLocalNotificationBadgeAtTime()

◆ SetLaunchNotification()