UsageLogCriteria Class

Class used to filter usage log

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.1.0.0
C#
public class UsageLogCriteria
Inheritance
Object    UsageLogCriteria

Constructors

UsageLogCriteriaInitializes a new instance of the UsageLogCriteria class

Properties

ActionDateFrom Search for the action in the usage log preformed after the date specified NOTE: if you want to use this criterium remember to set UseActionDate property to true
ActionDateTo Search for the action in the usage log preformed before the date specified NOTE: if you want to use this criterium remember to set UseActionDate property to true
DocumentName Search for the usage log associated with documents with specified name NOTE: if you want to use this criterium remember to set UseDocumentName property to true
DocumentVersionIds The array with IDs of the document versions against which the search will be performed
FirstRow Specifies the first row from the whole result which should be returned as a partial result (page). This is a 0-based value.
IsAsc Specifies whether result should be in ascending order.
PageSize Specifies how many items should be returned as a partial result (page). NOTE: If the whole usage log contains 100 items and: - the FirstRow property equals to 9, - the PageSize property equals to 20 then the partial result will contain items from 10 (FirstRow + 1) to 29 (FirstRow + 1 + PageSize - 1)
PerformedBy Search for the action in the usage log preformed by user specified NOTE: if you want to use this criterium remember to set UsePerformedBy property to true
PerformedById Search for the action in the usage log preformed by user specified NOTE: if you want to use this criterium remember to set UsePerformedById property to true
Schema Search for the usage log associated with documents of specified schema NOTE: if you want to use this criterium remember to set UseSchema property to true
SortBy Specifies which column usage log will be sorted by. The value must be between 0 and 7.
Type Search for the specified type of action in the usage log NOTE: if you want to use this criterium remember to set UseType property to true
UseActionDate Specifies whether ActionDateFrom and ActionDateTo criteria should be taken into account
UseDocumentName Specifies whether DocumentName criterium should be taken into account
UsePerformedBy Specifies whether PerformedBy criteria should be taken into account
UsePerformedById Specifies whether PerformedBy criteria should be taken into account
UseSchema Specifies whether Schema criterium should be taken into account
UseType Specifies whether ActionDateFrom and ActionDateTo criteria should be taken into account

Extension Methods

See Also