ILocalNotificationService

Interface for local notification modules

Windows
MacOS
Linux

Syntax

class ILocalNotificationService

Remarks

Interface for local notification modules

Functions

Name Description

Public function

void

 

CancelLocalNotification

(
    const FString& ActivationEvent
)

Cancel a local notification given the ActivationEvent

Public function

void

 

ClearAllLocalNotifications()

Clear all pending local notifications.

Public function

void

 

GetLaunchNotification

(
    bool& NotificationLaunchedApp,
    FString& ActivationEvent,
    int32& FireDate
)

Get the local notification that was used to launch the app

Public function

void

 

ScheduleLocalNotificationAtTime

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

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

Public function

void

 

ScheduleLocalNotificationBadgeAtTime

(
    const FDateTime& FireDateTime,
    bool LocalTime,
    const FString& ActivationEvent
)

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

Public function

void

 

SetLaunchNotification

(
    FString const& ActivationEvent,
    int32 FireDate
)

Set the local notification that was used to launch the app

References

Module

Engine

Header

Runtime/Engine/Public/LocalNotification.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback