Manager that handles the state of notifications for each detected BeamHint. We keep track of each individual BeamHintHeader and the notification preferences set for them (via IBeamHintPreferencesManager). Based on these, we track which hints have been displayed this session and/or which BeamHint.ContextObjects have a changed. We use these to keep an updated list of pending BeamHintType.Hint and BeamHintType.Validation notifications. These are cleared whenever the BeamableAssistantWindow is opened or focused. More...
Public Member Functions | |
| void | SetPreferencesManager (IBeamHintPreferencesManager preferencesManager) |
| Update the reference to the IBeamHintPreferencesManager used by this BeamHintNotificationManager. More... | |
| void | SetStorage (IBeamHintGlobalStorage hintGlobalStorage) |
| Update the reference to the IBeamHintGlobalStorage used by this BeamHintNotificationManager. More... | |
| void | OnInitialized () |
| Initializes the update callback for this IBeamHintSystem. More... | |
| void | ClearPendingNotifications (IEnumerable< BeamHintHeader > hintsToMarkAsSeen=null) |
| Call this to clear a set of pending hint notifications. This will clear them according to their established preferences in BeamHintPreferencesManager.GetHintNotificationPreferences. More... | |
| void | Update () |
| Detects whether or not we should take another pass to identify new notifications or not. This is added to EditorApplication.update during BeamEditor.Initialize. | |
Properties | |
| double | TickRate [getset] |
| Current amount of seconds to wait before checking for new notifications. | |
| IEnumerable< BeamHintHeader > | AllPendingNotifications [get] |
| Latest list of pending notifications that were found. | |
| IEnumerable< BeamHintHeader > | PendingHintNotifications [get] |
| Latest list of pending notifications of hints of type BeamHintType.Hint that were found. | |
| IEnumerable< BeamHintHeader > | PendingValidationNotifications [get] |
| Latest list of pending notifications of hints of type BeamHintType.Validation that were found. | |
| bool | IsBeamContextSystem [get] |
| False, since this is a globally accessible hint system. It does not get injected into BeamContext. | |
Detailed Description
Manager that handles the state of notifications for each detected BeamHint.
We keep track of each individual BeamHintHeader and the notification preferences set for them (via IBeamHintPreferencesManager). Based on these, we track which hints have been displayed this session and/or which BeamHint.ContextObjects have a changed.
We use these to keep an updated list of pending BeamHintType.Hint and BeamHintType.Validation notifications. These are cleared whenever the BeamableAssistantWindow is opened or focused.
Member Function Documentation
◆ ClearPendingNotifications()
|
inline |
Call this to clear a set of pending hint notifications. This will clear them according to their established preferences in BeamHintPreferencesManager.GetHintNotificationPreferences.
- Parameters
-
hintsToMarkAsSeen When null, clears all hints. Otherwise, clears only the specified hints.
◆ OnInitialized()
|
inline |
Initializes the update callback for this IBeamHintSystem.
Implements Beamable.Common.Assistant.IBeamHintSystem.
◆ SetPreferencesManager()
|
inline |
Update the reference to the IBeamHintPreferencesManager used by this BeamHintNotificationManager.
Implements Beamable.Common.Assistant.IBeamHintSystem.
◆ SetStorage()
|
inline |
Update the reference to the IBeamHintGlobalStorage used by this BeamHintNotificationManager.
Implements Beamable.Common.Assistant.IBeamHintSystem.
The documentation for this class was generated from the following file:
- com.beamable/Editor/BeamableAssistant/BeamHints/BeamHintNotificationManager.cs
