Home

Local Notifications

Local Notifications are reminders which show up on your screen after the app becomes inactive for a specific amount of time.

private function onPermissionGranted():void {
    // Success
    Enhance.enableLocalNotification("Game", "Play me!", 60);
}

private function onPermissionRefused():void {
    // Failure
}

private function init():void {
    Enhance.requestLocalNotificationPermission(onPermissionGranted, onPermissionRefused);
}

Methods

Enhance.requestLocalNotificationPermission

void Enhance.requestLocalNotificationPermission(
    Function onPermissionGrantedCallback,
    Function onPermissionRefusedCallback
)

Request a permission from the user to show local notifications. This won't have any effect on Android devices as you don't need a permission to schedule local notifications there (the successful callback will be still fired).

Parameters:

Function  onPermissionGrantedCallback - Called when a permission to schedule local notifications is granted or not required.

Function  onPermissionRefusedCallback - Called when a permission to schedule local notifications is refused. Trying to enable a notification will not have any effect.

Enhance.enableLocalNotification

void Enhance.enableLocalNotification(
    String title,
    String message,
    int delay
)

Schedule a new local notification, if possible. The notification will persist until you disable it manually. For example, if you set a notification for 60 seconds, it will invoke this notification 60 seconds after the app is closed, every time.

Parameters:

String  title - Title (header) of the notification.

String  message - Message (body) of the notification.

int  delay - Delay of the notification (how long to wait after app becomes inactive). Use seconds.

Enhance.disableLocalNotification

void Enhance.disableLocalNotification()

Disable any local notification that was previously enabled.