Interface IEventLogRoot
Корень журнала событий.
Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IEventLogRoot : IRecordsGroup, IApiObject, IApiEntity, INotifyPropertyChanged
Properties
AutoClearHistoryStorageTimeInDays
Возвращает и задает, сколько дней необходимо хранить историю при включенной автоочистке.
Declaration
int AutoClearHistoryStorageTimeInDays { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
IsAutoClearEnabled
Возвращает и задает признак того, что автоочистка журнала включена.
Declaration
bool IsAutoClearEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
IsLoggingEnabled
Возвращает и задает признак того, что в текущей сессии включено логирование.
Declaration
bool IsLoggingEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
IsLoggingEnabledGlobal
Возвращает и задает признак того, что логирование включено глобально.
Declaration
bool IsLoggingEnabledGlobal { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
SessionRecordsGroups
Дочерние группы записей журнала событий в сессии.
Declaration
IApiReadOnlyCollection<ISessionRecordsGroup> SessionRecordsGroups { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<ISessionRecordsGroup> |
Methods
AddRecord(string, EventRecordType)
Добавляет пользовательское событие в журнал событий.
Declaration
void AddRecord(string message, EventRecordType type)
Parameters
| Type | Name | Description |
|---|---|---|
| string | message | Сообщение пользовательского события. |
| EventRecordType | type | Тип пользовательского события. |
AddRecord(string, EventRecordType, IApiObject)
Добавляет пользовательское событие в журнал событий.
Declaration
void AddRecord(string message, EventRecordType type, IApiObject apiObject)
Parameters
| Type | Name | Description |
|---|---|---|
| string | message | Сообщение пользовательского события. |
| EventRecordType | type | Тип пользовательского события. |
| IApiObject | apiObject | Объект АПИ |
AddSessionRecordsGroupDirectly(string, string, IUser, DateTime, DateTime, SessionRecordsGroupResult)
Напрямую добавляет в журнал событий запись о сессии.
Declaration
ISessionRecordsGroup AddSessionRecordsGroupDirectly(string moduleName, string machineName, IUser user, DateTime openingDateTime, DateTime closingDateTime, SessionRecordsGroupResult result)
Parameters
| Type | Name | Description |
|---|---|---|
| string | moduleName | Имя модуля. |
| string | machineName | Имя машины. |
| IUser | user | Пользователь. |
| DateTime | openingDateTime | Время открытия сессии. |
| DateTime | closingDateTime | Время закрытия сессии. |
| SessionRecordsGroupResult | result | Результат сессии. |
Returns
| Type | Description |
|---|---|
| ISessionRecordsGroup | Новая запись о сессии. |
ClearLog()
Очищает журнал событий.
Declaration
void ClearLog()
FindEventRecordsContainsMessage(string)
Возвращает коллекцию IEventRecord, содержащих сообщение пользовательского события.
Declaration
IApiReadOnlyCollection<IEventRecord> FindEventRecordsContainsMessage(string message)
Parameters
| Type | Name | Description |
|---|---|---|
| string | message | Сообщение пользовательского события. |
Returns
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IEventRecord> | Коллекция пользовательских сообщений |
FindEventRecordsContainsMessage(string, DateTime, DateTime)
Возвращает коллекцию IEventRecord, содержащих сообщение пользовательского события, в промежутке между датами.
Declaration
IApiReadOnlyCollection<IEventRecord> FindEventRecordsContainsMessage(string message, DateTime startDateTime, DateTime finishDateTime)
Parameters
| Type | Name | Description |
|---|---|---|
| string | message | Сообщение пользовательского события. |
| DateTime | startDateTime | Дата начала события |
| DateTime | finishDateTime | Дата окончания события |
Returns
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IEventRecord> | Коллекция пользовательских сообщений в промежутке между датами |