Skip to main content

Class Notification

Represents a blueprint for a notification.

Assembly: Dalamud.dll​
View Source​
Declaration
public sealed record Notification : INotification, IEquatable<Notification>

Implements:
Dalamud.Interface.ImGuiNotification.INotification, System.IEquatable<Dalamud.Interface.ImGuiNotification.Notification>

Properties​

DefaultDuration​

Gets the default value for Dalamud.Interface.ImGuiNotification.Notification.InitialDuration and Dalamud.Interface.ImGuiNotification.Notification.ExtensionDurationSinceLastInterest.

View Source​
Declaration
public static TimeSpan DefaultDuration { get; }

Content​

Gets or sets the content body of the notification.

View Source​
Declaration
public string Content { get; set; }

Title​

Gets or sets the title of the notification.

View Source​
Declaration
public string? Title { get; set; }

MinimizedText​

Gets or sets the text to display when the notification is minimized.

View Source​
Declaration
public string? MinimizedText { get; set; }

Type​

Gets or sets the type of the notification.

View Source​
Declaration
public NotificationType Type { get; set; }

Icon​

Gets or sets the icon source, in case Dalamud.Interface.ImGuiNotification.INotification.IconTextureTask is not set or the task has faulted.

View Source​
Declaration
public INotificationIcon? Icon { get; set; }

IconTexture​

Gets or sets a texture wrap that will be used in place of Dalamud.Interface.ImGuiNotification.INotification.Icon if set.

View Source​
Declaration
public IDalamudTextureWrap? IconTexture { get; set; }

IconTextureTask​

Gets or sets a task that results in a texture wrap that will be used in place of Dalamud.Interface.ImGuiNotification.INotification.Icon if available.

View Source​
Declaration
public Task<IDalamudTextureWrap?>? IconTextureTask { get; set; }

HardExpiry​

Gets or sets the hard expiry.

View Source​
Declaration
public DateTime HardExpiry { get; set; }

InitialDuration​

Gets or sets the initial duration.

View Source​
Declaration
public TimeSpan InitialDuration { get; set; }

ExtensionDurationSinceLastInterest​

Gets or sets the new duration for this notification once the mouse cursor leaves the window and the window is no longer focused.

View Source​
Declaration
public TimeSpan ExtensionDurationSinceLastInterest { get; set; }

ShowIndeterminateIfNoExpiry​

Gets or sets a value indicating whether to show an indeterminate expiration animation if Dalamud.Interface.ImGuiNotification.INotification.HardExpiry is set to System.DateTime.MaxValue.

View Source​
Declaration
public bool ShowIndeterminateIfNoExpiry { get; set; }

RespectUiHidden​

Gets or sets a value indicating whether to respect the current UI visibility state.

View Source​
Declaration
public bool RespectUiHidden { get; set; }

Minimized​

Gets or sets a value indicating whether the notification has been minimized.

View Source​
Declaration
public bool Minimized { get; set; }

UserDismissable​

Gets or sets a value indicating whether the user can dismiss the notification by themselves.

View Source​
Declaration
public bool UserDismissable { get; set; }

Progress​

Gets or sets the progress for the background progress bar of the notification.

View Source​
Declaration
public float Progress { get; set; }

Implements​