Class GameNotificationsManager
Global notifications manager that serves as a wrapper for multiple platforms' notification systems.
Inherited Members
Namespace: NotificationSamples
Syntax
public class GameNotificationsManager : MonoBehaviourProperties
AutoBadging
Gets whether this manager automatically increments badge numbers.
Declaration
public bool AutoBadging { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Initialized
Gets whether this manager has been initialized.
Declaration
public bool Initialized { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Mode
Gets the operating mode for this manager.
Declaration
public GameNotificationsManager.OperatingMode Mode { get; }Property Value
| Type | Description |
|---|---|
| GameNotificationsManager.OperatingMode |
See Also
PendingNotifications
Gets a collection of notifications that are scheduled or queued.
Declaration
public List<PendingNotification> PendingNotifications { get; }Property Value
| Type | Description |
|---|---|
| List<PendingNotification> |
Platform
Gets the implementation of the notifications for the current platform;
Declaration
public IGameNotificationsPlatform Platform { get; }Property Value
| Type | Description |
|---|---|
| IGameNotificationsPlatform |
Serializer
Gets or sets the serializer to use to save pending notifications to disk if we're in RescheduleAfterClearing mode.
Declaration
public IPendingNotificationsSerializer Serializer { get; set; }Property Value
| Type | Description |
|---|---|
| IPendingNotificationsSerializer |
Methods
CancelAllNotifications()
Cancels all scheduled notifications.
Declaration
public void CancelAllNotifications()Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has not been called. |
CancelNotification(Int32)
Cancels a scheduled notification.
Declaration
public void CancelNotification(int notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | notificationId | The ID of the notification to cancel. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has not been called. |
CreateNotification()
Creates a new notification object for the current platform.
Declaration
public IGameNotification CreateNotification()Returns
| Type | Description |
|---|---|
| IGameNotification | The new notification, ready to be scheduled, or null if there's no valid platform. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has not been called. |
DismissAllNotifications()
Dismisses all displayed notifications.
Declaration
public void DismissAllNotifications()Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has not been called. |
DismissNotification(Int32)
Dismisses a displayed notification.
Declaration
public void DismissNotification(int notificationId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | notificationId | The ID of the notification to dismiss. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has not been called. |
GetLastNotification()
Declaration
public IGameNotification GetLastNotification()Returns
| Type | Description |
|---|---|
| IGameNotification |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException |
Initialize(GameNotificationChannel[])
Initialize the notifications manager.
Declaration
public void Initialize(params GameNotificationChannel[] channels)Parameters
| Type | Name | Description |
|---|---|---|
| GameNotificationChannel[] | channels | An optional collection of channels to register, for Android |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Initialize(GameNotificationChannel[]) has already been called. |
OnApplicationFocus(Boolean)
Respond to application foreground/background events.
Declaration
protected void OnApplicationFocus(bool hasFocus)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | hasFocus |
OnDestroy()
Clean up platform object if necessary
Declaration
protected virtual void OnDestroy()ScheduleNotification(IGameNotification)
Schedules a notification to be delivered.
Declaration
public PendingNotification ScheduleNotification(IGameNotification notification)Parameters
| Type | Name | Description |
|---|---|---|
| IGameNotification | notification | The notification to deliver. |
Returns
| Type | Description |
|---|---|
| PendingNotification |
Update()
Check pending list for expired notifications, when in queue mode.
Declaration
protected virtual void Update()Events
LocalNotificationDelivered
Event fired when a scheduled local notification is delivered while the app is in the foreground.
Declaration
public event Action<PendingNotification> LocalNotificationDeliveredEvent Type
| Type | Description |
|---|---|
| Action<PendingNotification> |
LocalNotificationExpired
Event fired when a queued local notification is cancelled because the application is in the foreground when it was meant to be displayed.
Declaration
public event Action<PendingNotification> LocalNotificationExpiredEvent Type
| Type | Description |
|---|---|
| Action<PendingNotification> |