View Source

Interface IAction

Defines a back office action that can be permission assigned or subscribed to for notifications

Namespace: Umbraco.Cms.Core.Actions
Assembly: Umbraco.Core.dll
Syntax
public interface IAction : IDiscoverable
Remarks

If an IAction returns false for both ShowInNotifier and CanBePermissionAssigned then the IAction should not exist

Fields

View Source

ActionAlias

Declaration
public const string ActionAlias = null
Field Value
Type Description
System.String
View Source

ActionLetter

Declaration
public const char ActionLetter = '\0'
Field Value
Type Description
System.Char

Properties

View Source

Alias

Gets the alias for this action (must be unique). This is all lower-case because of case sensitive filesystems, see issue: https://github.com/umbraco/Umbraco-CMS/issues/11670.

Declaration
string Alias { get; }
Property Value
Type Description
System.String
View Source

CanBePermissionAssigned

Gets a value indicating whether whether to allow assigning permissions based on this action

Declaration
bool CanBePermissionAssigned { get; }
Property Value
Type Description
System.Boolean
View Source

Category

Gets the category used for this action

Declaration
string Category { get; }
Property Value
Type Description
System.String
Remarks

Used in the UI when assigning permissions

View Source

Icon

Gets the icon to display for this action

Declaration
string Icon { get; }
Property Value
Type Description
System.String
View Source

Letter

Gets the letter used to assign a permission (must be unique).

Declaration
char Letter { get; }
Property Value
Type Description
System.Char
View Source

ShowInNotifier

Gets a value indicating whether whether to allow subscribing to notifications for this action

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