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

Interface for local notification relay. See AppleLocalNotificationRelay and GoogleLocalNotificationRelay for concrete implementations. More...

Inheritance diagram for Core.Platform.SDK.Notification.Internal.ILocalNotificationRelay:
Inheritance 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

Interface for local notification relay. See AppleLocalNotificationRelay and GoogleLocalNotificationRelay for concrete implementations.

Member Function Documentation

◆ CancelNotification()

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

Cancel a specific notification.

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

Implemented in Core.Platform.SDK.Notification.Internal.GoogleLocalNotificationRelay, and Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.

◆ CreateNotificationChannel()

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

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.

Implemented in Core.Platform.SDK.Notification.Internal.GoogleLocalNotificationRelay, and Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.

◆ ScheduleNotification()

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

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.

Implemented in Core.Platform.SDK.Notification.Internal.GoogleLocalNotificationRelay, and Core.Platform.SDK.Notification.Internal.DummyLocalNotificationRelay.


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