Beamable SDK
Public Member Functions | List of all members
Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay Class Reference

Dummy local notification handler, for use as a stand-in within Editor and other contexts where OS notifications are not available. More...

Inheritance diagram for Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay:
Inheritance graph
[legend]
Collaboration diagram for Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay:
Collaboration graph
[legend]

Public Member Functions

void CreateNotificationChannel (string id, string name, string description)
 Create a notification channel. More...
 
void ScheduleNotification (string channel, string key, string title, string message, DateTime when, Dictionary< string, string > data)
 Schedule a local notification for the future. More...
 
void CancelNotification (string key)
 Cancel a specific notification. More...
 
void ClearDeliveredNotifications ()
 

Detailed Description

Dummy local notification handler, for use as a stand-in within Editor and other contexts where OS notifications are not available.

Member Function Documentation

◆ CancelNotification()

void Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.CancelNotification ( string  key)
inline

Cancel a specific notification.

Parameters
keyKey for identifying which notification to cancel, like "DBCONSOLE" or "BUILD_TIMER".

Implements Core.Platform.SDK.Notification.Internal.ILocalNotificationRelay.

◆ CreateNotificationChannel()

void Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.CreateNotificationChannel ( string  id,
string  name,
string  description 
)
inline

Create a notification channel.

Parameters
idIdentifier of the channel (Android) or category (iOS) of the notification.
nameUser facing name for this channel.
descriptionUser facing description for this channel.

Implements Core.Platform.SDK.Notification.Internal.ILocalNotificationRelay.

◆ ScheduleNotification()

void Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.ScheduleNotification ( string  channel,
string  key,
string  title,
string  message,
DateTime  when,
Dictionary< string, string >  data 
)
inline

Schedule a local notification for the future.

Parameters
channelIdentifier of the channel (Android) or category (iOS) of the notification.
keyArbitrary string key that can be used for cancelling the notification.
titleTitle text of the notification.
messageBody text of the notification.
whenTime when the notification should arrive. This should be a future timestamp.
dataArbitrary key/value data to attach to the notification.

Implements Core.Platform.SDK.Notification.Internal.ILocalNotificationRelay.


The documentation for this class was generated from the following file: