Interface IActiveNotification

Represents an active notification.

Assembly: Dalamud.dll

View Source

Declaration

public interface IActiveNotification : INotification

Properties

Id

Gets the ID of this notification.

View Source

Declaration

long Id { get; }

CreatedAt

Gets the time of creating this notification.

View Source

Declaration

DateTime CreatedAt { get; }

EffectiveExpiry

Gets the effective expiry time.

View Source

Declaration

DateTime EffectiveExpiry { get; }

DismissReason

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

View Source

Declaration

NotificationDismissReason? DismissReason { get; }

Methods

DismissNow()

Dismisses this notification.

View Source

Declaration

void DismissNow()

ExtendBy(TimeSpan)

Extends this notifiation.

View Source

Declaration

void ExtendBy(TimeSpan extension)

Parameters

Type	Name	Description
System.TimeSpan	extension	The extension time.

SetIconTexture(IDalamudTextureWrap?)

Sets the icon from Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap, overriding the icon.

View Source

Declaration

void SetIconTexture(IDalamudTextureWrap? textureWrap)

Parameters

Type	Name	Description
Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap	textureWrap	The new texture wrap to use, or null to clear and revert back to the icon specified

from [Dalamud.Interface.ImGuiNotification.INotification.Icon](../../Dalamud.Interface.ImGuiNotification/Interfaces/INotification#icon). |

SetIconTexture(Task<IDalamudTextureWrap?>?)

Sets the icon from Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap, overriding the icon, once the given task completes.

View Source

Declaration

void SetIconTexture(Task<IDalamudTextureWrap?>? textureWrapTask)

Parameters

Type	Name	Description
System.Threading.Tasks.Task<Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap>	textureWrapTask	The task that will result in a new texture wrap to use, or null to clear and

revert back to the icon specified from [Dalamud.Interface.ImGuiNotification.INotification.Icon](../../Dalamud.Interface.ImGuiNotification/Interfaces/INotification#icon). |

SetIconTexture(IDalamudTextureWrap?, bool)

Sets the icon from Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap, overriding the icon.

View Source

Declaration

void SetIconTexture(IDalamudTextureWrap? textureWrap, bool leaveOpen)

Parameters

Type	Name	Description
Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap	textureWrap	The new texture wrap to use, or null to clear and revert back to the icon specified

from [Dalamud.Interface.ImGuiNotification.INotification.Icon](../../Dalamud.Interface.ImGuiNotification/Interfaces/INotification#icon). |

| System.Boolean | leaveOpen | Whether to keep the passed <code class="paramref">textureWrap</code> not disposed. |

SetIconTexture(Task<IDalamudTextureWrap?>?, bool)

Sets the icon from Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap, overriding the icon, once the given task completes.

View Source

Declaration

void SetIconTexture(Task<IDalamudTextureWrap?>? textureWrapTask, bool leaveOpen)

Parameters

Type	Name	Description
System.Threading.Tasks.Task<Dalamud.Interface.Textures.TextureWraps.IDalamudTextureWrap>	textureWrapTask	The task that will result in a new texture wrap to use, or null to clear and

revert back to the icon specified from [Dalamud.Interface.ImGuiNotification.INotification.Icon](../../Dalamud.Interface.ImGuiNotification/Interfaces/INotification#icon). |

| System.Boolean | leaveOpen | Whether to keep the result from the passed <code class="paramref">textureWrapTask</code> not disposed. |

Events

Dismiss

Invoked upon dismissing the notification.

View Source

Declaration

event Action<INotificationDismissArgs> Dismiss

Event Type

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

Click

Invoked upon clicking on the notification.

View Source

Declaration

event Action<INotificationClickArgs> Click

Event Type

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

DrawActions

Invoked upon drawing the action bar of the notification.

View Source

Declaration

event Action<INotificationDrawArgs> DrawActions

Event Type

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