Export (0) Print
Expand All

SPFileUsageDefinition members

SharePoint 2013

Provides the usage definition for file operation statistics.

The SPFileUsageDefinition type exposes the following members.

  Name Description
Public method SPFileUsageDefinition() Initializes a new default instance of the SPFileUsageDefinition class.
Public method SPFileUsageDefinition(SPFarm) Initializes a new instance of the SPFileUsageDefinition class based on the specified SharePoint Foundation farm.
Top

  Name Description
Public property Columns Gets a two-dimensional array that provides the column name and SQL database type used to store data for this usage provider. (Overrides SPUsageProvider.Columns.)
Public property DaysToKeepData Gets or sets the number of days to keep data. (Inherited from SPUsageDefinition.)
Public property DaysToKeepDetailedData The number of days to keep data. (Inherited from SPUsageProvider.)
Public property DaysToKeepUsageFiles This property controls the number of days to keep detailed data. Must be less than DaysToKeepDetailedData. (Inherited from SPUsageDefinition.)
Public property Description Gets a string with a detailed description of this type of SPUsageDefinition. (Overrides SPUsageDefinition.Description.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Enabled Gets or sets a value specifying whether usage logging has been enabled for this type. (Inherited from SPUsageDefinition.)
Public property EnableReceivers Gets or sets a value indicating whether usage receivers are enabled for this usage type. (Inherited from SPUsageDefinition.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden Gets a Boolean value that determines whether the usage definition is shown in the user interface. (Inherited from SPUsageDefinition.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property MaxTotalSizeInBytes This property stores the maximum SQL storage size for the data of this provider. (Inherited from SPUsageDefinition.)
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property ProvisionSchema Indicates whether this usage provider should have schema provision in the logging store. (Inherited from SPUsageProvider.)
Public property Receivers Gets this usage definition's collection of receivers. (Inherited from SPUsageDefinition.)
Public property RetentionPeriod The number of days to keep data for this provider. (Inherited from SPUsageProvider.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TableName Gets the primary unique name given to objects created in the logging store for this usage provider. (Overrides SPUsageProvider.TableName.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UsageEntryType Contains the type of the SPUsageEntry class that corresponds to this SPUsageDefinition instance. (Overrides SPUsageDefinition.UsageEntryType.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)
Top

  Name Description
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method CreateTable Creates a table in the logging store. (Inherited from SPUsageProvider.)
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Public method ExecuteNonQuery Executes a Transact-SQL query that does not return any rows. (Inherited from SPUsageProvider.)
Public method ExecuteReader Executes a Transact-SQL query that returns a rowset. (Inherited from SPUsageProvider.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method ImportEntries Uploads page request usage entries to corresponding import table in Usage Database. (Inherited from SPUsageProvider.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Public method OnProvisioning This method is called to allow providers to perform any kind of SQL database initialization such as creation of tables or stored procedures. (Inherited from SPUsageProvider.)
Public method OnUnprovisioning This method is called to allow providers to revert any actions performed during provisioning of the provider. (Inherited from SPUsageProvider.)
Public method ParseLogFileCommonEntry Parse string array to usage table common columns: FarmId, UserLogin, SiteSubscriptionId, LogTime, and CorrelationId. (Inherited from SPUsageProvider.)
Public method ParseLogFileEntry([]) Converts the object array into an instance of this usage entry, which then can be imported into the usage database. (Overrides SPUsageProvider.ParseLogFileEntry([]).)
Public method ParseLogFileEntry(String) (Inherited from SPUsageProvider.)
Public method ProcessData Called daily by the usage processing timer job. Can be used to process and/or aggregate data for this usage definition. (Inherited from SPUsageDefinition.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method TruncateData Called daily by the usage processing timer job. Can be used to purge all data for this usage definition. (Inherited from SPUsageDefinition.)
Protected method TryGetDateTime (Inherited from SPUsageProvider.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Updates this usage provider in the configuration database. (Inherited from SPUsageProvider.)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Protected method Validate Validates the properties of this usage definition (Inherited from SPUsageDefinition.)
Public method WriteDataRowToServer Writes a row of data into a table in the logging store. (Inherited from SPUsageProvider.)
Top

Community Additions

ADD
Show:
© 2014 Microsoft