Class ActivityLog
The ActivityLog class is intended to be a centralized logging system
for the Application.
Inheritance
System.Object
ActivityLog
Assembly: LymeTemplateApi.Models.dll
Syntax
public class ActivityLog : object
Constructors
ActivityLog()
Declaration
ActivityLog(String)
Declaration
public ActivityLog(string activity)
Parameters
| Type |
Name |
Description |
| System.String |
activity |
|
ActivityLog(String, Nullable<Int32>)
Declaration
public ActivityLog(string activity, int? userInfoId)
Parameters
| Type |
Name |
Description |
| System.String |
activity |
|
| System.Nullable<System.Int32> |
userInfoId |
|
ActivityLog(String, Nullable<Int32>, String, Int32)
Declaration
public ActivityLog(string activity, int? userInfoId, string referenceTable, int referenceId)
Parameters
| Type |
Name |
Description |
| System.String |
activity |
|
| System.Nullable<System.Int32> |
userInfoId |
|
| System.String |
referenceTable |
|
| System.Int32 |
referenceId |
|
Properties
Activity
The activity being performed. Make sure this doesn't
value doesn't change for similar activities. Put specifics
in the Notes or Data properties.
FUTURE: Will probably refactor this into an ActivityType
table so that it's more efficient and more meaningful.
Declaration
public string? Activity { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.String> |
|
Data
This column really can contain any data, but is usually
used to store JSON data and is meant to be machine readable.
Declaration
public string? Data { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.String> |
|
DateEntered
Declaration
public DateTime DateEntered { get; set; }
Property Value
| Type |
Description |
| DateTime |
|
DeveloperNotes
Sometimes activities have technical details that are only
interesting to a developer. (e.g. SQL Statements)
Declaration
public string? DeveloperNotes { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.String> |
|
EmailMessageId
Foreign key to the EmailMessage table.
Declaration
public int? EmailMessageId { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|
Id
The primary key. It's very concievable that this field may need
to be changed to a long or bigint data type.
Declaration
public int Id { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
Notes
Specific details about the activity that area human readable.
Declaration
public string? Notes { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.String> |
|
ReferenceId
If the activity is related to any particular table or entity
the ID of that entity can be stored in this column. Most keys
in the system are int primary keys, this field is of that type.
In the rare occurence that it might not be, use the Data
property.
Declaration
public int? ReferenceId { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|
ReferenceTable
If the activity is related to any particular table or entity
it can be noted in this column. This makes querying activities
based on entity much easier since the Data column is not easily
queryable or indexable.
Declaration
public string? ReferenceTable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.String> |
|
UserInfo
Declaration
public UserInfo UserInfo { get; set; }
Property Value
UserInfoId
The ID of the user (in the UserInfo table) that is associated
with this activity.
Declaration
public int? UserInfoId { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|