Interface IStudioNotification

The contract defining the Notification

Namespace: Sdl.Desktop.IntegrationApi.Interfaces
Assembly: Sdl.Desktop.IntegrationApi.dll
Syntax
public interface IStudioNotification

Properties

Action

The action to be executed for this notification

Declaration
IStudioNotificationCommand Action { get; set; }
Property Value
Type Description
IStudioNotificationCommand

AllowsUserToDismiss

Set this to true if you only if the user would be able to remove a notification

Declaration
bool AllowsUserToDismiss { get; set; }
Property Value
Type Description
System.Boolean

AlwaysVisibleDetails

A list of details that are always visible on the Notification

Declaration
List<string> AlwaysVisibleDetails { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

ClearNotificationAction

The notification will be removed if AllowsUserToDismiss is set to true

Declaration
IStudioNotificationCommand ClearNotificationAction { get; set; }
Property Value
Type Description
IStudioNotificationCommand

Id

Gets or sets the identifier.

Declaration
Guid Id { get; set; }
Property Value
Type Description
System.Guid

IsActionVisible

Set this to true if the Action Should be visible

Declaration
bool IsActionVisible { get; set; }
Property Value
Type Description
System.Boolean

IsExpanderVisible

Set this to True of the Expander should be visible

Declaration
bool IsExpanderVisible { get; set; }
Property Value
Type Description
System.Boolean

IsLinkVisible

Set this to True of the Link should be visible

Declaration
bool IsLinkVisible { get; set; }
Property Value
Type Description
System.Boolean

LinkAction

The action to be executed for open HyperLink text

Declaration
IStudioNotificationCommand LinkAction { get; set; }
Property Value
Type Description
IStudioNotificationCommand

OtherDetails

Additional notification details visible only if the user wants to have them displayed

Declaration
List<string> OtherDetails { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Title

The Title of the Notification

Declaration
string Title { get; set; }
Property Value
Type Description
System.String

Extension Methods