notifications.cancelNotification()

Type Function
Return value none
Revision Release 2024.3703
Keywords notification, notifications, cancelNotification
See also Local/Push Notifications (guide)
notifications.scheduleNotification()
notifications.*

Overview

Removes the specified notification (or all notifications) from the scheduler, status bar, and/or notification center.

Syntax

notifications.cancelNotification( [notificationId] )
notificationId (optional)

A notification reference ID returned by notifications.scheduleNotification(). If no ID is passed, all notifications are cancelled.

Example

local notifications = require( "plugin.notifications" )

-- Schedule a notification
local options = {
    alert = "Wake up!"
}

local notificationId = notifications.scheduleNotification( 60, options )

-- Cancel the above notification
notifications.cancelNotification( notificationId )