Home

Local Notifications

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

function on_permission_granted()
    enhance.enableLocalNotification("Game", "Play me!", 60)
end

function on_permission_refused()
    -- Failure
end

enhance.requestLocalNotificationPermission(on_permission_granted, on_permission_refused)

Methods

enhance.requestLocalNotificationPermission

nil 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

nil enhance.enableLocalNotification(
    string title,
    string message,
    number 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.

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

enhance.disableLocalNotification

nil enhance.disableLocalNotification()

Disable any local notification that was previously enabled.

This site uses cookies to improve your browsing experience and analyze site traffic. You consent to our use of cookies if you continue to use this site. Learn More Accept