Export (0) Print
Expand All

SPUsageDefinition members

An abstract class that is the common interface for defining a usage type. A corresponding SPUsageEntry class is used for doing the actual usage logging.

The SPUsageDefinition type exposes the following members.

  Name Description
Public method SPUsageDefinition() The default constructor, which is called implicitly by the default constructors of derived classes.
Protected method SPUsageDefinition(SPFarm) This constructor initializes the object instance to be used with a specific SPFarm object containing the global settings for the servers, services, and solutions that are installed in a server farm. This constructor is intended for use only by the SPFarm object and should not be used by any other object.
Top

  Name Description
Public property DaysToKeepData Gets or sets the number of days to keep data.
Public property DaysToKeepDetailedData This property controls the number of days to keep detailed data. Must be less than DaysToKeepData.
Public property DaysToKeepUsageFiles This property controls the number of days to keep detailed data. Must be less than DaysToKeepDetailedData.
Public property Description Gets a detailed string description of this type of SPUsageDefinition.
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.
Public property EnableReceivers Gets or sets a value indicating whether usage receivers are enabled for this usage type.
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.
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.
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 Receivers Gets this usage definition's collection of receivers.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property Static member TableColumnsMaxSize This property returns the maximum length of usage definition column. It is typically used when instantiating an SPColumnDefinition object representing a string column.
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.
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 Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
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 Static member GetLocal<T> This static method is used instead of the constructor to create a new instance of the derived SPUsageDefinition class, if necessary, and to retrieve it from the database.
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 Called during import of usage data with the actual usage entries that have been collected from the usage log files.
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 ProcessData Called daily by the usage processing timer job. Can be used to process and/or aggregate data for this usage definition.
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.
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() Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
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 (Overrides SPPersistedObject.Validate().)
Top

Community Additions

ADD
Show:
© 2014 Microsoft