add documentation and change interface for cancelAllNotifications

This commit is contained in:
2025-02-02 21:09:07 -08:00
parent f8ff7f9cc9
commit 6172a04427

View File

@@ -56,15 +56,27 @@ export class NotificationService {
return this._lastRefreshedTimeMs && Date.now() - this._lastRefreshedTimeMs < thirtyMinutesMs; return this._lastRefreshedTimeMs && Date.now() - this._lastRefreshedTimeMs < thirtyMinutesMs;
} }
/**
* Queue a notification to be sent.
* @param deviceId The device ID to send the notification to.
* @param shuttleId Shuttle ID of ETA object to check.
* @param stopId Stop ID of ETA object to check.
*/
public async scheduleNotification({ deviceId, shuttleId, stopId }: ScheduledNotificationData) { public async scheduleNotification({ deviceId, shuttleId, stopId }: ScheduledNotificationData) {
} }
/**
* Cancel a pending notification.
* @param deviceId The device ID of the notification.
* @param shuttleId Shuttle ID of the ETA object.
* @param stopId Stop ID of the ETA object.
*/
public async cancelNotification({ deviceId, shuttleId, stopId }: ScheduledNotificationData) { public async cancelNotification({ deviceId, shuttleId, stopId }: ScheduledNotificationData) {
} }
public cancelAllNotifications() { public cancelAllNotifications(deviceId: string) {
} }
} }