Class ChangeLogItemBase
Base class for EPiServer CMS change log items
Inheritance
Inherited Members
Namespace: EPiServer.ChangeLog
Assembly: EPiServer.dll
Version: 7.19.2Syntax
public abstract class ChangeLogItemBase : IChangeLogItem, IChangeLogUpdatableItem
Constructors
ChangeLogItemBase()
Initializes a new instance of the ChangeLogItemBase class.
Declaration
protected ChangeLogItemBase()
ChangeLogItemBase(Int32, Int32, String)
Initializes a new instance of the ChangeLogItemBase class.
Declaration
protected ChangeLogItemBase(int category, int action, string changedBy)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | category | The category. |
System.Int32 | action | The action. |
System.String | changedBy | The changed by. |
Properties
Action
The action of the change log
Declaration
public virtual int Action { get; protected set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Category
The category of the change log
Declaration
public virtual int Category { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
ChangeDate
The change date of the change log
Declaration
public virtual DateTime ChangeDate { get; }
Property Value
Type | Description |
---|---|
System.DateTime |
ChangedBy
The user who action generated the change log
Declaration
public virtual string ChangedBy { get; }
Property Value
Type | Description |
---|---|
System.String |
ExtensionProperties
Implement this to serialize/deserialize your custom properties to/from the Change Log storage
Declaration
protected abstract IDictionary<string, string> ExtensionProperties { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> |
LogData
The log data of the change log
Declaration
public virtual string LogData { get; protected set; }
Property Value
Type | Description |
---|---|
System.String |
SequenceNumber
The sequence number of the change log
Declaration
public virtual long SequenceNumber { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
Title
Return a description of your Change Log item
Declaration
protected abstract string Title { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
InitializeFromStorage(Int64, String, DateTime, Int32, Int32, String)
Initialize the change log item with the values provided
Declaration
public virtual void InitializeFromStorage(long sequenceNumber, string logData, DateTime changeDate, int category, int action, string changedBy)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | sequenceNumber | The sequence number of the change log |
System.String | logData | The log data of the change log |
System.DateTime | changeDate | The change date of the change log |
System.Int32 | category | The category of the change log |
System.Int32 | action | The action of the change log |
System.String | changedBy | The user who action generated the change log |
Update(Int64, DateTime)
Updates the specified sequence number and the change date.
Declaration
public virtual void Update(long sequenceNumber, DateTime changeDate)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | sequenceNumber | The sequence number. |
System.DateTime | changeDate | The change date. |