Skip to main content
Version: 14.x (API 14) [Current]

Interface IActiveNotification

Represents an active notification.

Remarks​

Not to be implemented by plugins.

Assembly: Dalamud.dll​
Declaration
public interface IActiveNotification : INotification

Properties​

Id​

Gets the ID of this notification.

Declaration
long Id { get; }
Remarks​

This value does not change.

CreatedAt​

Gets the time of creating this notification.

Declaration
DateTime CreatedAt { get; }
Remarks​

This value does not change.

EffectiveExpiry​

Gets the effective expiry time.

Declaration
DateTime EffectiveExpiry { get; }
Remarks​

Contains System.DateTime.MaxValue if the notification does not expire.

DismissReason​

Gets the reason how this notification got dismissed. null if not dismissed.

Declaration
NotificationDismissReason? DismissReason { get; }
Remarks​

This includes when the hide animation is being played.

Methods​

DismissNow()​

Dismisses this notification.

Declaration
void DismissNow()
Remarks​

If the notification has already been dismissed, this function does nothing.

ExtendBy(TimeSpan)​

Extends this notifiation.

Declaration
void ExtendBy(TimeSpan extension)
Parameters​
TypeNameDescription
System.TimeSpanextensionThe extension time.
Remarks​

This does not override Dalamud.Interface.ImGuiNotification.INotification.HardExpiry.

Events​

Dismiss​

Invoked upon dismissing the notification.

Declaration
event Action<INotificationDismissArgs> Dismiss
Event Type​

System.Action<Dalamud.Interface.ImGuiNotification.EventArgs.INotificationDismissArgs>

Remarks​

The event callback will not be called, if it gets dismissed after plugin unload.

Click​

Invoked upon clicking on the notification.

Declaration
event Action<INotificationClickArgs> Click
Event Type​

System.Action<Dalamud.Interface.ImGuiNotification.EventArgs.INotificationClickArgs>

Remarks​

Note that this function may be called even after Dalamud.Interface.ImGuiNotification.IActiveNotification.Dismiss has been invoked.

DrawActions​

Invoked upon drawing the action bar of the notification.

Declaration
event Action<INotificationDrawArgs> DrawActions
Event Type​

System.Action<Dalamud.Interface.ImGuiNotification.EventArgs.INotificationDrawArgs>

Remarks​

Note that this function may be called even after Dalamud.Interface.ImGuiNotification.IActiveNotification.Dismiss has been invoked.