ILocalNotificationService

Interface for local notification modules

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/LocalNotification.h

Include

#include "LocalNotification.h"

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

 

CancelLocalNotification

(
    int32 NotificationId
)

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

int32

 

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

int32

 

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss