File: D:/HostingSpaces/MBoogaard/oosting-horseriding.com/wwwroot/bin/CMS.WebAnalytics.xml
<?xml version="1.0"?>
<doc>
<assembly>
<name>CMS.WebAnalytics</name>
</assembly>
<members>
<member name="T:CMS.WebAnalytics.ActivitiesUsageDataSource">
<summary>
Module usage tracking data source for activities module.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivitiesUsageDataSource.mSettingsToLog">
<summary>
Settings keyes which are logged.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitiesUsageDataSource.GetData">
<summary>
Get all module statistical data.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitiesUsageDataSource.GetSettingsUsage(System.Boolean)">
<summary>
Returns how many times is specific setting used with value which is not same as default value.
Only settings on running sites (if <paramref name="global"/> is true), not hidden and not custom are retrieved.
Only global settings when <paramref name="global"/> is false.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitiesUsageDataSource.Name">
<summary>
Get the data source name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityData">
<summary>
Container for the activity data.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.LogTime">
<summary>
Time when activity was performed
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.ContactID">
<summary>
Contact ID
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.SiteID">
<summary>
Site ID
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.Type">
<summary>
Activity type
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.Title">
<summary>
Activity title (optional). If null or blank, title is generated automatically using 'TitleData'.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.TitleData">
<summary>
Additional title data for autogenerating 'Title'. This text is used to create user-friendly 'Title' automatically.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.ItemID">
<summary>
Related item ID
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.URL">
<summary>
URL of the page where activity occurred
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.ItemDetailID">
<summary>
Related detail item ID
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.NodeID">
<summary>
Related node ID
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.Value">
<summary>
Activity value
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.IP">
<summary>
IP address of the user
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.Campaign">
<summary>
Campaign under which the activity occurred
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.URLReferrer">
<summary>
URL of previous page
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.Culture">
<summary>
Document culture
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.OtherParams">
<summary>
Other custom parameters
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.IsAlreadyProcessed">
<summary>
Marks whether the activity is already in the database or not.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityData.ProcessedActivityID">
<summary>
If activity is already saved (<see cref="F:CMS.WebAnalytics.ActivityData.IsAlreadyProcessed"/> is true), this field contains ID of an activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityData.#ctor">
<summary>
Constructor. Sets <see cref="F:CMS.WebAnalytics.ActivityData.LogTime"/> to Now.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityNewsletterUnsubscribingFromAll">
<summary>
Unsubscribing from any marketing communication (from all newsletters).
</summary>
</member>
<member name="T:CMS.WebAnalytics.Activity">
<summary>
Abstract activity type
</summary>
</member>
<member name="M:CMS.WebAnalytics.Activity.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="M:CMS.WebAnalytics.Activity.Log">
<summary>
Logs activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Activity.RegisterProperties">
<summary>
Registers the object properties.
</summary>
</member>
<member name="E:CMS.WebAnalytics.Activity.OnAfterLogActivity">
<summary>
Occurs after successful logging of activity occurs.
</summary>
</member>
<member name="E:CMS.WebAnalytics.Activity.OnCustomActivityCheck">
<summary>
Occurs before logging activity just after regular check for logging activity. Enables users to set custom validation if logging should be enabled.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.Data">
<summary>
Activity data.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.CheckViewMode">
<summary>
Indicates if view mode should be checked. Default true.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.IsLiveSite">
<summary>
Indicates if running on live site.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.CurrentUser">
<summary>
Current user.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.DocumentLogActivity">
<summary>
Indicates if current document or his parent (when inheriting value) enables to log activity.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.SiteName">
<summary>
Current site name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.ActivityType">
<summary>
Activity type
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.SettingsKeyName">
<summary>
Activity settings key name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.Activity.LoggingEnabled">
<summary>
Indicates if logging of activity is enabled.
</summary>
</member>
<member name="T:CMS.WebAnalytics.Activity.LoggingActivityEnabled">
<summary>
Method for customization of security check.
</summary>
<param name="sender">Current activity</param>
<param name="e">Event arguments</param>
<returns>Returns true if activity can be logged.</returns>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterUnsubscribingFromAll.#ctor(CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="issue">Issue object. Issue object may be null and in this case activity is logged without any additional information.</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterUnsubscribingFromAll.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterUnsubscribingFromAll.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityCustomTableFormSubmit">
<summary>
Class for custom table form submit activity
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityCustomTableFormSubmit.#ctor(CMS.DataEngine.DataClassInfo,System.Int32,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor
</summary>
<param name="customTable">Custom table ID</param>
<param name="itemID">Custom table item identifier</param>
<param name="activityTitle">Activity title</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustomTableFormSubmit.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustomTableFormSubmit.SettingsKeyName">
<summary>
Name of the settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityEvents">
<summary>
Activity events.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityEvents.ActivityLogged">
<summary>
Event fires immediately when activity is being logged. This event is fired when activity is being logged using Activity.Log() or ActivityLogProvider.LogActivity() methods.
Event is not fired when activity is logged using ActivityInfoProvider.SetInfo().
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityLoggedEventArgs">
<summary>
Arguments for the ActivityLoggedHandler event handler.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityLoggedEventArgs.ActivityData">
<summary>
Data of the logged activity.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityLoggedHandler">
<summary>
Event handler for the event when activity is being logged.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLoggedHandler.StartEvent(CMS.WebAnalytics.ActivityData)">
<summary>
Initiates event.
</summary>
<param name="activityData">Logged activity</param>
<returns>Event handler</returns>
</member>
<member name="T:CMS.WebAnalytics.ActivityLogger">
<summary>
Provides interface for logging activities.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLogger.LogActivity(CMS.WebAnalytics.ActivityData)">
<summary>
Logs activity to the storage.
</summary>
<param name="activityData">Activity data</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityLogger.LogDirectory">
<summary>
Logs directory.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivitySettingsHelper">
<summary>
Provides comfortable access to settings keys for activities.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.GetBoolValue(System.String,System.String)">
<summary>
Returns key value (bool).
</summary>
<param name="siteName">Site name (optional)</param>
<param name="keyName">Key name</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.GetLoggingEnabled(System.String,System.String,System.String)">
<summary>
Checks if specified activity logging is enabled.
</summary>
<param name="siteName">Site name</param>
<param name="keyname">Sttings key name of particular activity (e.g. "CMSCMPageVisits")</param>
<param name="activityType">Activity type code name (e.g. PredefinedActivityType.PAGE_VISIT)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.OnlineMarketingEnabled(System.Int32)">
<summary>
Determines whether on-line marketing modul is activated.
</summary>
<param name="siteId">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.OnlineMarketingEnabled(System.String)">
<summary>
Determines whether on-line marketing modul is activated.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.IsModuleLoaded">
<summary>
Determines whether on-line marketing modul is available.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ActivitiesEnabled(System.Int32)">
<summary>
Returns true if activities logging is enabled.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ActivitiesEnabled(System.String)">
<summary>
Returns true if activities logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.UserRegistrationEnabled(System.String)">
<summary>
Returns true if user registration logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.AddingProductToWLEnabled(System.Int32)">
<summary>
Returns true if adding product to WL logging is enabled.
</summary>
<param name="siteId">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.AddingProductToWLEnabled(System.String)">
<summary>
Returns true if adding product to WL logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ForumPostSubscriptionEnabled(System.String)">
<summary>
Returns true if forum post subscription logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ForumPostsEnabled(System.String)">
<summary>
Returns true if forum post logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.AbuseReportEnabled(System.String)">
<summary>
Returns true if abuse report subscription logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.WikiContributionUpdateEnabled(System.Int32)">
<summary>
Returns true if wiki contribution update logging is enabled.
</summary>
<param name="siteId">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.WikiContributionUpdateEnabled(System.String)">
<summary>
Returns true if wiki contribution update logging is enabled.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.IPLoggingEnabled(System.Int32)">
<summary>
Returns true if IP logging is allowed.
</summary>
<param name="siteId">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.IPLoggingEnabled(System.String)">
<summary>
Returns true if IP logging is allowed.
</summary>
<param name="siteName">Site name (or NULL for global setting)</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ActivitiesEnabledAndModuleLoaded(System.Int32)">
<summary>
Returns true if global logging switch for the given site is enabled and online marketing module is loaded.
</summary>
<param name="siteId">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ActivitiesEnabledAndModuleLoaded(System.String)">
<summary>
Returns true if global logging switch for the given site is enabled and online marketing module is loaded.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySettingsHelper.ActivitiesEnabledForThisUser(CMS.Membership.UserInfo)">
<summary>
Returns true if logging activity is enabled for given user.
</summary>
<param name="ui">User info</param>
</member>
<member name="T:CMS.WebAnalytics.ActivityTypeInfo">
<summary>
ActivityTypeInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityTypeInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityTypeInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.#ctor">
<summary>
Constructor - Creates an empty ActivityTypeInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new ActivityTypeInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)">
<summary>
Checks the permissions of the object.
</summary>
<param name="permission">Permission type</param>
<param name="siteName">Name of the site</param>
<param name="userInfo">UserInfo object</param>
<param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)">
<summary>
Clones metafile and inserts it to DB as new object.
</summary>
<param name="settings">Cloning settings</param>
<param name="result">Cloning result</param>
<param name="originalObject">Original source BaseInfo (object being cloned)</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeDisplayName">
<summary>
Gets or sets the display name of the activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeDescription">
<summary>
Gets or sets the description for the activity.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeIsCustom">
<summary>
Gets or sets whether the activity is custom.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeName">
<summary>
Gets or sets the the code name of the activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeID">
<summary>
Gets or sets the ID of the activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeEnabled">
<summary>
Gets or sets whether the activity is enabled.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeManualCreationAllowed">
<summary>
Gets or sets whether the activity is enabled.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeMainFormControl">
<summary>
Gets or sets name of form control (selector) for setting ItemID
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityTypeInfo.ActivityTypeDetailFormControl">
<summary>
Gets or sets name of form control (selector) for setting ItemDetailID
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityTypeInfoProvider">
<summary>
Class providing ActivityTypeInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.#ctor">
<summary>
Constructor using ID and codename Hashtables.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypes">
<summary>
Returns a query for all the ActivityTypeInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeInfo(System.Int32)">
<summary>
Returns activity type with specified ID.
</summary>
<param name="typeId">Activity type ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeInfo(System.String)">
<summary>
Returns activity type with specified name.
</summary>
<param name="typeName">Activity type name</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.SetActivityTypeInfo(CMS.WebAnalytics.ActivityTypeInfo)">
<summary>
Sets (updates or inserts) specified activity type.
</summary>
<param name="typeObj">Activity type to be set</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.DeleteActivityTypeInfo(CMS.WebAnalytics.ActivityTypeInfo)">
<summary>
Deletes specified activity type.
</summary>
<param name="typeObj">Activity type to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.DeleteActivityTypeInfo(System.Int32)">
<summary>
Deletes activity type with specified ID.
</summary>
<param name="typeId">Activity type ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeDisplayName(System.String)">
<summary>
Returns display name of particular activity.
</summary>
<param name="typeName">Code name of activity type</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeEnabled(System.String)">
<summary>
Checks if specified activity type is enabled.
</summary>
<param name="typeName">Code name of activity type</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypesInternal">
<summary>
Returns a query for all the ActivityTypeInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeInfoInternal(System.Int32)">
<summary>
Returns activity type with specified ID.
</summary>
<param name="typeId">Activity type ID</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.GetActivityTypeInfoInternal(System.String)">
<summary>
Returns activity type with specified name.
</summary>
<param name="typeName">Activity type name</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.SetActivityTypeInfoInternal(CMS.WebAnalytics.ActivityTypeInfo)">
<summary>
Sets (updates or inserts) specified activity type.
</summary>
<param name="typeObj">Activity type to be set</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityTypeInfoProvider.DeleteActivityTypeInfoInternal(CMS.WebAnalytics.ActivityTypeInfo)">
<summary>
Deletes specified activity type.
</summary>
<param name="typeObj">Activity type to be deleted</param>
</member>
<member name="T:CMS.WebAnalytics.ActivityAbuseReport">
<summary>
Abuse report activity type.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityAbuseReport.#ctor(CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor
</summary>
<param name="abuseReportInfo">Abuse report</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityAbuseReport.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityAbuseReport.SettingsKeyName">
<summary>
Activity settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityChatBase">
<summary>
Base class for all activity types belonging to the Chat module.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityChatBase.#ctor(CMS.WebAnalytics.ActivityContext,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
<param name="useReffererAsCurrentURL">If true, tha URL parameter of the activity will be set to value received as Refferer header. Refferer will be set to empty string.</param>
</member>
<member name="T:CMS.WebAnalytics.ActivityProductAddedToWishlist">
<summary>
Activity product added to wishlist.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityProductAddedToWishlist.#ctor(System.String,System.Int32,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="skuName">Product name</param>
<param name="skuId">SKU ID</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductAddedToWishlist.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductAddedToWishlist.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityBizFormSubmit">
<summary>
Form submit activity type.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityBizFormSubmit.#ctor(System.String,System.Int32,System.Int32,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Form submit constructor.
</summary>
<param name="formName">Form name</param>
<param name="bizFormID">Form ID</param>
<param name="itemID">Record ID</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityBizFormSubmit.ActivityType">
<summary>
Type of the activity
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityBizFormSubmit.SettingsKeyName">
<summary>
Name of the settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityBlogComment">
<summary>
Blog comment activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityBlogComment.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Blog comment constructor
</summary>
<param name="blogComment">Blog comment info</param>
<param name="blogPost">Blog post tree node</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityBlogComment.ActivityTypeEnabled(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo)">
<summary>
Indicates if logging of specific activity is enabled.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityBlogComment.BlogComment_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
Updates contact record.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityBlogComment.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityBlogComment.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityChatAcceptInitiatedChat">
<summary>
Activity for accepting initiated chat request.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityChatAcceptInitiatedChat.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatAcceptInitiatedChat.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatAcceptInitiatedChat.SettingsKeyName">
<summary>
Name of corresponding settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityChatRequestSupport">
<summary>
Activity for chat support request.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityChatRequestSupport.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatRequestSupport.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatRequestSupport.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityChatRequestSupportOfflineForm">
<summary>
Activity for requesting support using offline support form (when there are no online supporters on chat).
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityChatRequestSupportOfflineForm.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatRequestSupportOfflineForm.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatRequestSupportOfflineForm.SettingsKeyName">
<summary>
Name of the setting key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityCustom">
<summary>
Custom activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityCustom.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustom.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustom.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityCustomerRegistration">
<summary>
Activity customer registration.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityCustomerRegistration.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="customerInfo">Customer info object</param>
<param name="userInfo">User info object</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityCustomerRegistration.ActivityCustomerRegistration_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
Activity was logged.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustomerRegistration.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityCustomerRegistration.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityEventBooking">
<summary>
Activity event booking.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityEventBooking.#ctor(CMS.DataEngine.BaseInfo,System.String,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Activity event booking constructor.
</summary>
<param name="eventNode">Event node TreeNode</param>
<param name="documentName">Document name</param>
<param name="eventAttendeeInfo">Event attendee info object.</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityEventBooking.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityEventBooking.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityExternalSearch">
<summary>
Activity external search.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityExternalSearch.#ctor(System.String,System.String,CMS.Base.IDataContainer,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="searchKeyword">Search keyword</param>
<param name="searchEngine">Search engine</param>
<param name="currentPage">Activity page</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityExternalSearch.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityExternalSearch.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityForumPost">
<summary>
Activity new forum post.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityForumPost.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,System.Boolean,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="forumPostInfo">Forum post info</param>
<param name="forumInfo">Forum info</param>
<param name="currentDocument">Current document</param>
<param name="forumLogActivity">Indicates if logging is enabled</param>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityForumPost.ActivityForumPost_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
Event after logging.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityForumPost.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityForumPost.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityInternalSearch">
<summary>
Activity internal search.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityInternalSearch.#ctor(System.String,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Constructor.
</summary>
<param name="searchKeyword">Search keyword</param>
<param name="currentPage">Current page</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityInternalSearch.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityInternalSearch.SettingsKeyName">
<summary>
Settings name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityJoinGroup">
<summary>
Activity group join.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityJoinGroup.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="gmi">GroupMemberInfo object</param>
<param name="groupInfo">Group object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityJoinGroup.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityJoinGroup.SettingsKeyName">
<summary>
Activity settings name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityLandingPage">
<summary>
Activity landing page.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLandingPage.#ctor(CMS.Base.ITreeNode,System.String,System.String,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="currentPage">Current page TreeNode</param>
<param name="documentName">Name of the document</param>
<param name="ABTestVariantName">Name of the AB variant</param>
<param name="MVTCombinationName">Name of the MVT combination</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityLandingPage.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityLandingPage.SettingsKeyName">
<summary>
Name of the settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityLeaveGroup">
<summary>
Activity leave group.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLeaveGroup.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="gmi">GroupMemberInfo object</param>
<param name="group">Group object</param>
<param name="currentPage">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityLeaveGroup.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityLeaveGroup.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityMessageBoardComment">
<summary>
Activity message board comment.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityMessageBoardComment.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="boardMessageInfo">BoardMessageInfo object</param>
<param name="boardInfo">BoardInfo object</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityMessageBoardComment.ActivityLeaveGroup_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after logging event.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityMessageBoardComment.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityMessageBoardComment.SettingsKeyName">
<summary>
Setting name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityNewsletterClickThrough">
<summary>
Newsletter email click through activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterClickThrough.#ctor(System.Int32,System.String,System.String,CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="contactID">Current contact ID</param>
<param name="originalURL">URL of the origin</param>
<param name="value">Activity value</param>
<param name="issue">Issue object</param>
<param name="newsletter">Newsletter object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterClickThrough.ActivityNewsletterClickThrough_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
Event after successful logging.
</summary>
</member>
<member name="E:CMS.WebAnalytics.ActivityNewsletterClickThrough.OnAfterClickThroughActivity">
<summary>
Occurs after click through activity is logged.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterClickThrough.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterClickThrough.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityNewsletterOpen">
<summary>
Activity open newsletter e-mail.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterOpen.#ctor(System.Int32,System.String,CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="contactID">Current contact ID</param>
<param name="value">Activity value</param>
<param name="issue">Issue object</param>
<param name="newsletter">Newsletter object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterOpen.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterOpen.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityNewsletterSubscribing">
<summary>
Newsletter subscribe activity.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterSubscribing.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="subscriber">Subscriber object</param>
<param name="newsletter">Newsletter object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterSubscribing.ActivityNewsletterSubscribing_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after logging event.
</summary>
</member>
<member name="E:CMS.WebAnalytics.ActivityNewsletterSubscribing.OnAfterNewsletterSubscribingActivity">
<summary>
Occurs after newsletter subscribing activity is logged.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterSubscribing.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterSubscribing.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityNewsletterUnsubscribing">
<summary>
Activity newsletter unsubscribing.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityNewsletterUnsubscribing.#ctor(CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="newsletter">Newsletter object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterUnsubscribing.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityNewsletterUnsubscribing.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityPageVisit">
<summary>
Activity page visit.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityPageVisit.#ctor(CMS.Base.ITreeNode,System.String,System.String,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="currentPage">Current page</param>
<param name="documentName">Name of the document</param>
<param name="ABTestVariantName">AB variant name</param>
<param name="MVTCombinationName">MVT combination name</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityPageVisit.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityPageVisit.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityPollVoting">
<summary>
Activity poll voting.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ActivityPollVoting.POLL_ANSWER_SEPARATOR">
<summary>
Answer IDs separator (in case of multiple answers this character is used as separator)
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityPollVoting.#ctor(CMS.DataEngine.BaseInfo,CMS.Base.ITreeNode,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="pollInfo">PollInfo object</param>
<param name="currentDoc">Current document</param>
<param name="answers">Answers</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityPollVoting.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityPollVoting.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityProductAddedToShoppingCart">
<summary>
Activity product added to shopping cart.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityProductAddedToShoppingCart.#ctor(System.String,System.Int32,System.Int32,CMS.WebAnalytics.ActivityContext)">
<summary>
Activity product added to shopping cart.
</summary>
<param name="skuName">Name of the product</param>
<param name="quantity">Quantity</param>
<param name="skuID">SKU ID</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductAddedToShoppingCart.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductAddedToShoppingCart.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityProductRemovedFromShoppingCart">
<summary>
Activity product removed from shopping cart.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityProductRemovedFromShoppingCart.#ctor(CMS.DataEngine.BaseInfo,System.String,System.Int32,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="cartItem">Cart item object</param>
<param name="SKUName">Product name</param>
<param name="contactID">Contact ID. Optional.</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductRemovedFromShoppingCart.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityProductRemovedFromShoppingCart.SettingsKeyName">
<summary>
Settings key name
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityPurchase">
<summary>
Activity purchase.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityPurchase.#ctor(System.String,System.Int32,System.Double,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="totalPriceAsString">Formatted price</param>
<param name="orderID">Order ID</param>
<param name="totalPrice">Total price</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityPurchase.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityPurchase.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityPurchasedProduct">
<summary>
Activity purchased product.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityPurchasedProduct.#ctor(System.String,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="SKUName">Formatted name of the product</param>
<param name="cartItem">Cart item object</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityPurchasedProduct.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityPurchasedProduct.SettingsKeyName">
<summary>
Name of the settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityRating">
<summary>
Activity rating.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityRating.#ctor(System.String,System.Double,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="title">Activity title</param>
<param name="value">Activity value</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityRating.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityRating.SettingsKeyName">
<summary>
Settings key name
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityRegistration">
<summary>
Activity registration
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityRegistration.#ctor(CMS.Base.IUserInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor
</summary>
<param name="ui">UserInfo object</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityRegistration.ActivityRegistration_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after successful logging.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityRegistration.GetFriendlyUserName(CMS.Base.IUserInfo)">
<summary>
Returns formatted user name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityRegistration.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityRegistration.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivitySubscriptionBlogPost">
<summary>
Activity blog post subscription
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionBlogPost.#ctor(System.String,CMS.Base.ITreeNode,CMS.Base.ITreeNode,CMS.DataEngine.BaseInfo,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="blogName">Blog name.</param>
<param name="blogNode">Blog node. Optional.</param>
<param name="blogPost">Blog post node.</param>
<param name="bpsi">Blog post subscription object.</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionBlogPost.ActivitySubscriptionBlogPost_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after logging event.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionBlogPost.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionBlogPost.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivitySubscriptionForumPost">
<summary>
Activity subscription forum post.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionForumPost.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="fi">ForumInfo object</param>
<param name="fsi">ForumSubscriptionInfo object</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionForumPost.ActivitySubscriptionForumPost_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after successful logging event.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionForumPost.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionForumPost.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivitySubscriptionMessageBoard">
<summary>
Activity subscription message board.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionMessageBoard.#ctor(CMS.DataEngine.BaseInfo,CMS.DataEngine.BaseInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="boardInfo">BoardInfo object</param>
<param name="boardSubscriptionInfo">BoardSubscriptionInfo object</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivitySubscriptionMessageBoard.ActivitySubscriptionMessageBoard_OnAfterLogActivity(System.Object,System.EventArgs)">
<summary>
On after successful logging event.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionMessageBoard.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivitySubscriptionMessageBoard.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityUserContributionDelete">
<summary>
Activity user contribution delete.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityUserContributionDelete.#ctor(CMS.Base.ITreeNode,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="node">Document being deleted</param>
<param name="documentName">Document name</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionDelete.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionDelete.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityUserContributionInsert">
<summary>
Activity user contribution insert.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityUserContributionInsert.#ctor(CMS.Base.ITreeNode,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Activity default constructor.
</summary>
<param name="node">Node being inserted</param>
<param name="documentName">Document name.</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionInsert.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionInsert.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityUserContributionUpdate">
<summary>
Activity user contribution update.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityUserContributionUpdate.#ctor(CMS.Base.ITreeNode,System.String,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="node">Node being updated</param>
<param name="documentName">Document name</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionUpdate.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserContributionUpdate.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityUserLogin">
<summary>
Activity user login.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityUserLogin.#ctor(System.Int32,CMS.Base.IUserInfo,CMS.Base.ITreeNode,CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="contactID">Contact ID. Optional.</param>
<param name="ui">UserInfo object</param>
<param name="currentDoc">Current document</param>
<param name="variables">Environment variables required for proper logging of activities. Use AnalyticsContext.ActivityEnvironmentVariables.</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityUserLogin.GetFriendlyUserName(CMS.Base.IUserInfo)">
<summary>
Returns formatted user name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserLogin.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityUserLogin.SettingsKeyName">
<summary>
Settings key name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityChatAcceptAutomaticallyInitiatedChat">
<summary>
Activity for accepting initiated chat request which was issued automatically (using Automatically initiated chat request).
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityChatAcceptAutomaticallyInitiatedChat.#ctor(CMS.WebAnalytics.ActivityContext)">
<summary>
Default constructor.
</summary>
<param name="variables">Environment variables required for proper logging of activities</param>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatAcceptAutomaticallyInitiatedChat.ActivityType">
<summary>
Activity type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityChatAcceptAutomaticallyInitiatedChat.SettingsKeyName">
<summary>
Name of corresponding settings key.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityLogHelper">
<summary>
Provides functionality for activity logging.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLogHelper.ProcessActivityUpdateMerged(System.Int32,System.Int32)">
<summary>
Updates activities performed by now merged contacts, so their ActivityActiveContactID column correctly points to the ID of the now parent contact.
ActivityOriginalContactID column will be set to the ID of the now merged contact who previously performed the activity.
</summary>
<param name="firstActivityId">First activity ID to be processed</param>
<param name="lastActivityId">last activity ID to be processed</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityLogHelper.GetContactIDByMembership(System.Int32,System.Int32,System.Int32,System.String)">
<summary>
Gets contact ID from membership relations.
</summary>
<param name="relatedId">Related ID </param>
<param name="memberType">Member type (user, subscriber, customer)</param>
<param name="siteId">Site ID</param>
<param name="where">Additional WHERE condition</param>
</member>
<member name="M:CMS.WebAnalytics.ActivityLogHelper.GetContactIDByEmail(System.String,System.Int32)">
<summary>
Returns contact ID for e-mail address.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ActivityLogHelper.GetActivityDependencyCacheKeys(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Gets cache keys which should be touched after batch of activities is inserted to the database.
</summary>
<param name="contactIDs">IDs of the contacts whose activities were created</param>
<returns>List of cache dependencies which should be touched after inserting a batch of activities</returns>
</member>
<member name="T:CMS.WebAnalytics.AssetController">
<summary>
Handles the campaign assets.
</summary>
</member>
<member name="M:CMS.WebAnalytics.AssetController.Post(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Performs saving of the <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/> corresponding to the given <see cref="T:CMS.WebAnalytics.CampaignAssetViewModel"/>.
The <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/> is inserted with the values obtained from <paramref name="campaignAssetViewModel"/>.
</summary>
<param name="campaignAssetViewModel">Instance of updated view-model. This instance will be used to creating corresponding <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/></param>
<returns>
<c>HTTP status code 400 Bad request</c>, if model state of binded <paramref name="campaignAssetViewModel"/> was not valid;
otherwise, <c>HTTP status code 200 OK</c> with serialized <paramref name="campaignAssetViewModel"/>. This campaign has <see cref="P:CMS.WebAnalytics.CampaignEditViewModel.CampaignID"/> filled
with the data from the DB.
</returns>
</member>
<member name="M:CMS.WebAnalytics.AssetController.Put(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Performs update of the <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/> corresponding.
The <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/> values are updated with the values from <paramref name="campaignAssetViewModel"/>.
</summary>
<remarks>
No dirty checking is performed, <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/> will be updated even if no change was made to the object.
HTTP verb PUT is not supported, therefore this request accepts only the POST requests.
</remarks>
<param name="campaignAssetViewModel">Instance of updated view-model. This instance will be used to update corresponding <see cref="T:CMS.WebAnalytics.CampaignAssetInfo"/></param>
<returns>
<c>HTTP status code 400 Bad request</c>, if model state of binded <paramref name="campaignAssetViewModel"/> was not valid
otherwise, <c>HTTP status code 200 OK</c> with updated <paramref name="campaignAssetViewModel"/>.
</returns>
</member>
<member name="M:CMS.WebAnalytics.AssetController.Delete(System.Int32)">
<summary>
Deletes given campaign asset.
</summary>
<remarks>
When response is returned, there will be no campaign with given ID in database.
HTTP verb DELETE is not supported, therefore this request accepts only the GET requests.
</remarks>
<param name="campaignAssetID">ID of asset</param>
<returns>
Returns <c>HTTP status code 200 OK</c> if request was successful.
</returns>
</member>
<member name="T:CMS.WebAnalytics.CampaignController">
<summary>
Handles getting of campaigns.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Get">
<summary>
Gets list of campaigns from current site.
</summary>
<returns>
HTTP response message containing the status code dependent on whether the action was successful or not.
Returns 200 OK status and list of campaigns from current site.
</returns>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Post(CMS.WebAnalytics.CampaignEditViewModel)">
<summary>
Performs saving of the <see cref="T:CMS.WebAnalytics.CampaignInfo"/> corresponding to the given <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/>.
The <see cref="T:CMS.WebAnalytics.CampaignInfo"/> is inserted with the values obtained from <paramref name="model"/>.
</summary>
<remarks>
<see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignName"/> is set to <see cref="F:CMS.DataEngine.InfoHelper.CODENAME_AUTOMATIC"/> to let the <see cref="T:CMS.WebAnalytics.CampaignInfoProvider"/> decide
what codename should be used based on the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignDisplayName"/>.
</remarks>
<param name="model">Instance of updated view-model. This instance will be used to creating corresponding <see cref="T:CMS.WebAnalytics.CampaignInfo"/></param>
<returns>
<c>HTTP status code 400 Bad request</c>, if model state of binded <paramref name="model"/> was not valid;
otherwise, <c>HTTP status code 200 OK</c> with serialized <paramref name="model"/>. This campaign has <see cref="P:CMS.WebAnalytics.CampaignEditViewModel.CampaignID"/> filled
with the data from the DB.
</returns>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Put(CMS.WebAnalytics.CampaignEditViewModel)">
<summary>
Performs update of the <see cref="T:CMS.WebAnalytics.CampaignInfo"/> corresponding to the given <see cref="P:CMS.WebAnalytics.CampaignEditViewModel.CampaignID"/> property.
The <see cref="T:CMS.WebAnalytics.CampaignInfo"/> values are updated with the values from <paramref name="model"/>.
</summary>
<remarks>
No dirty checking is performed, <see cref="T:CMS.WebAnalytics.CampaignInfo"/> will be updated even if no change was made to the object.
HTTP verb PUT is not supported, therefore this request accepts only the POST requests.
</remarks>
<param name="model">Instance of updated view-model. This instance will be used to update corresponding <see cref="T:CMS.WebAnalytics.CampaignInfo"/></param>
<returns>
<c>HTTP status code 400 Bad request</c>, if model state of binded <paramref name="model"/> was not valid -or -
if no campaign was found for the provided <see cref="P:CMS.WebAnalytics.CampaignEditViewModel.CampaignID"/> if provided model is not valid;
otherwise, <c>HTTP status code 200 OK</c> with updated <paramref name="model"/>.
</returns>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Delete(System.Int32)">
<summary>
Deletes campaign with given id only for current site.
</summary>
<remarks>
When response is returned, there will be no campaign with given ID in database.
HTTP verb DELETE is not supported, therefore this request accepts only the GET requests.
</remarks>
<param name="id">ID of campaign</param>
<returns>
Returns <c>HTTP status code 200 OK</c> if request was successful.
</returns>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Finish(System.Int32)">
<summary>
Finishes campaign and data will not be tracked anymore.
Doesn't finish already finished campaign.
</summary>
<param name="id">Campaign id</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.Launch(System.Int32)">
<summary>
The method launches a campaign. This includes the following steps:
<ul>
<li>Campaign will start tracking data</li>
<li>All linked page assets will be published</li>
<li>All linked email assets will be sent</li>
</ul>
Doesn't launch an already launched campaign or a campaign from a different site.
</summary>
<remarks>
When pages are published <see cref="P:CMS.DocumentEngine.TreeNode.DocumentPublishFrom"/> is set to <see cref="P:System.DateTime.Now"/>.
Also <see cref="P:CMS.DocumentEngine.TreeNode.DocumentPublishTo"/> is reset if date is set to past.
Furthermore, pages under workflow are left untouched and all culture variants are published.
</remarks>
<param name="id">Campaign id</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.LaunchLog(System.Int32)">
<summary>
The method collect informations about actions which are performed during campaign launch.
For more information see <see cref="M:CMS.WebAnalytics.CampaignController.Launch(System.Int32)"/>.
</summary>
<param name="id">Campaign id</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.UpdateNewsletterUTMCodes(System.String,System.String)">
<summary>
Updates UTM campaign codes in newsletters.
</summary>
<param name="oldUTMCode">Original UTM campaign code.</param>
<param name="newUTMCode">New UTM campaign code.</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignController.PublishPagesAndFiles(CMS.WebAnalytics.CampaignInfo,System.DateTime)">
<summary>
Publishes assets of type file and page added to the given campaign.
</summary>
<param name="campaign">Campaign</param>
<param name="campaignLaunched">Date time when campaign have been launched.</param>
</member>
<member name="T:CMS.WebAnalytics.CampaignLaunchLog">
<summary>
Collection explanations messages for all actions that needs to be performed before campaign is launched.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignLaunchLog.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignLaunchLog.Messages">
<summary>
Explanations texts.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignListItemViewModelService">
<summary>
Service that provides method to fill all the properties in <see cref="T:CMS.WebAnalytics.CampaignListItemViewModel"/> objects.
</summary>
</member>
<member name="T:CMS.WebAnalytics.Internal.ICampaignListItemViewModelService">
<summary>
Service that provides method to work with the <see cref="T:CMS.WebAnalytics.CampaignListItemViewModel"/> objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.ICampaignListItemViewModelService.GetModel(CMS.WebAnalytics.CampaignInfo,System.DateTime)">
<summary>
Method takes <see cref="T:CMS.WebAnalytics.CampaignInfo"/> and creates new instance of <see cref="T:CMS.WebAnalytics.CampaignListItemViewModel"/> containing all values
required for communication between Web API and javascript modules.
</summary>
<param name="campaign">Campaign info obtained from the database</param>
<param name="dateTime">Datetime, used to calculate the current status of campaign</param>
<exception cref="T:System.ArgumentNullException"><paramref name="campaign"/> is null</exception>
</member>
<member name="M:CMS.WebAnalytics.CampaignListItemViewModelService.GetModel(CMS.WebAnalytics.CampaignInfo,System.DateTime)">
<summary>
Method takes <see cref="T:CMS.WebAnalytics.CampaignInfo"/> and creates new instance of <see cref="T:CMS.WebAnalytics.CampaignListItemViewModel"/> containing all values
required for communication between Web API and javascript modules.
</summary>
<param name="campaign">Campaign info obtained from the database</param>
<param name="dateTime">Datetime, used to calculate the current status of campaign</param>
<exception cref="T:System.ArgumentNullException"><paramref name="campaign"/> is null</exception>
</member>
<member name="T:CMS.WebAnalytics.ICampaignAssetModelService">
<summary>
Service that provides method to work with the <see cref="T:CMS.WebAnalytics.CampaignAssetViewModel"/> objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ICampaignAssetModelService.GetStrategy(System.String)">
<summary>
Returns specific campaign asset model service strategy.
</summary>
<param name="type">Type of asset to work with.</param>
</member>
<member name="T:CMS.WebAnalytics.DateTimeController">
<summary>
This controller provides method for retrieving date time information from the server.
Because time zones can vary from the client and therefore using javascript Date object only could lead
to confusion, obtaining current date time should be always performed from the server.
</summary>
</member>
<member name="M:CMS.WebAnalytics.DateTimeController.GetCurrentSiteDateTime">
<summary>
Gets current date time for the <see cref="P:CMS.SiteProvider.SiteContext.CurrentSite"/>.
</summary>
<returns>DateTime for the current <see cref="T:CMS.SiteProvider.SiteInfo"/></returns>
</member>
<member name="T:CMS.WebAnalytics.CampaignAssetViewModel">
<summary>
View model for campaign assets.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.Type">
<summary>
Asset type.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.ID">
<summary>
Asset ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.AssetID">
<summary>
Asset info ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.Name">
<summary>
Asset name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.Link">
<summary>
Direct asset link.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.CampaignID">
<summary>
ID of campaign this asset belongs to. Used when creating or updating asset.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetViewModel.AdditionalProperties">
<summary>
Contains properties required by specific types of campaign assets.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignListItemViewModel">
<summary>
Represents listing View model of Campaign Info which can be serialized and used for communication between API controller and javascript services.
This wrapper has to be used because info objects cannot be easily serialized and deserialized.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.CampaignID">
<summary>
Unique integer identifier of the campaign. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignID"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.DisplayName">
<summary>
Name of the campaign used in listing and all reports. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignDisplayName"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.OpenFrom">
<summary>
Provides time from which the campaign will be running. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignOpenFrom"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.OpenTo">
<summary>
Provides time to which the champaign will be running. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignOpenTo"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.Visitors">
<summary>
Indicates how many visitor has reached campaign.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.Conversions">
<summary>
Indicates how many conversion happend in campaign.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.ConversionRate">
<summary>
Campaign conversion rate. It is calculated as <see cref="P:CMS.WebAnalytics.CampaignListItemViewModel.Conversions"/> divided by <see cref="P:CMS.WebAnalytics.CampaignListItemViewModel.Visitors"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.Status">
<summary>
Refers to the current status. Can be one of the <see cref="T:CMS.WebAnalytics.CampaignStatusEnum"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignListItemViewModel.DetailLink">
<summary>
Single object url for editing current campaign.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignEditViewModel">
<summary>
Represents View model of Campaign Info which can be serialized and used for communication between API controller and javascript services.
This wrapper has to be used because info objects cannot be easily serialized and deserialized.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignEditViewModel.#ctor">
<summary>
Empty constructor. Needs to be present to enable data binding performed by the Web API.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignEditViewModel.#ctor(CMS.WebAnalytics.CampaignInfo,System.DateTime)">
<summary>
Constructor takes <see cref="T:CMS.WebAnalytics.CampaignInfo"/> and creates new instance of <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/> containing all values
required for communication between Web API and javascript modules.
</summary>
<param name="campaign">Campaign info obtained from the database</param>
<param name="dateTime">Datetime, used to calculate the current status of campaign</param>
<exception cref="T:System.ArgumentNullException"><paramref name="campaign"/> is null</exception>
</member>
<member name="M:CMS.WebAnalytics.CampaignEditViewModel.FillCampaignInfo(CMS.WebAnalytics.CampaignInfo)">
<summary>
Fills given <paramref name="campaign"/> with data obtained from current instance of <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/>.
This method should be used whenever the call from client to the server with filled <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/> was made
and the incoming object values need to be copied to the existing <paramref name="campaign"/>.
</summary>
<param name="campaign">Campaign which will be filled with data from the current instance of <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/></param>
<exception cref="T:System.ArgumentNullException"><paramref name="campaign"/> is null</exception>
<returns><paramref name="campaign"/> filled with the data from current instance of <see cref="T:CMS.WebAnalytics.CampaignEditViewModel"/></returns>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.CampaignID">
<summary>
Unique integer identifier of the campaign. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignID"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.DisplayName">
<summary>
Name of the campaign used in listing and all reports. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignDisplayName"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.UTMCode">
<summary>
Campaign UTM code. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignUTMCode"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.Description">
<summary>
Campaign description used in reports, provides closer details about the campaign. Refers to the <see cref="P:CMS.WebAnalytics.CampaignInfo.CampaignDescription"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.Status">
<summary>
Refers to the current status. Can be one of the <see cref="T:CMS.WebAnalytics.CampaignStatusEnum"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.CodeName">
<summary>
Refers to codename of the campaign. This field is required for enabling single object pinning.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignEditViewModel.SiteName">
<summary>
Refers to site name campaign is assigned to. This field is required for enabling single object pinning.
</summary>
</member>
<member name="T:CMS.WebAnalytics.AbstractAssetModelStrategy">
<summary>
Class with shared logic for all asset model strategies.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ICampaignAssetModelStrategy">
<summary>
Interface that provides service methods to work with the <see cref="T:CMS.WebAnalytics.CampaignAssetViewModel"/> objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ICampaignAssetModelStrategy.GetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Returns asset info from view model.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.ICampaignAssetModelStrategy.GetAssetViewModel(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Returns view model from given asset info.
</summary>
<param name="info">Asset info.</param>
</member>
<member name="M:CMS.WebAnalytics.ICampaignAssetModelStrategy.SetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Sets data from asset model and returns updated view model.
This method is called when new asset is added to campaign.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.GetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Returns asset info from view model.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.GetAssetViewModel(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Returns view model from given asset info.
</summary>
<param name="info">Asset info.</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.SetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Sets data from asset model and returns updated view model.
This method is called when existing asset is being updated.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.GetRemovedAssetViewModel(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Returns default view model for asset with not existing linked object.
</summary>
<param name="asset">Asset</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.CreateConversion(System.String,System.Int32)">
<summary>
Creates conversion and stores it in DB.
</summary>
<param name="conversionDisplayName">Name of the new conversion</param>
<param name="siteID">Site ID</param>
</member>
<member name="M:CMS.WebAnalytics.AbstractAssetModelStrategy.RenameConversion(CMS.WebAnalytics.ConversionInfo,System.String)">
<summary>
Renames given conversion.
</summary>
<param name="conversion">Conversion to be renamed</param>
<param name="newConversionDisplayName">New conversion display name</param>
</member>
<member name="T:CMS.WebAnalytics.NewsletterAssetModelStrategy">
<summary>
Logic connected to newsletter issue modeling and storing.
</summary>
</member>
<member name="M:CMS.WebAnalytics.NewsletterAssetModelStrategy.GetAssetViewModel(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Returns view model from given asset info.
</summary>
<param name="info">Asset info.</param>
</member>
<member name="M:CMS.WebAnalytics.NewsletterAssetModelStrategy.SetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Sets data from asset model and returns updated view model.
This method is called when existing asset is being updated.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="T:CMS.WebAnalytics.PageAssetModelStrategy">
<summary>
Logic connected to page modeling and storing.
</summary>
</member>
<member name="M:CMS.WebAnalytics.PageAssetModelStrategy.GetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Returns asset info from view model.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.PageAssetModelStrategy.GetAssetViewModel(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Returns view model from given asset info.
</summary>
<param name="info">Asset info.</param>
</member>
<member name="M:CMS.WebAnalytics.PageAssetModelStrategy.SetAssetInfo(CMS.WebAnalytics.CampaignAssetViewModel)">
<summary>
Sets data from asset model and returns updated view model.
This method is called when existing asset is being updated.
</summary>
<param name="model">Asset view model.</param>
</member>
<member name="M:CMS.WebAnalytics.PageAssetModelStrategy.UpdateDocuments(System.Collections.Generic.IEnumerable{CMS.DocumentEngine.TreeNode},CMS.WebAnalytics.CampaignAssetViewModel,System.String)">
<summary>
Updates given documents from model.
</summary>
<param name="documents">Documents to be updated.</param>
<param name="model">Model with changes.</param>
<param name="conversionName">Conversion name.</param>
</member>
<member name="T:CMS.WebAnalytics.UTMCodeAttribute">
<summary>
Validates campaign UTM code. UTM code must be unique in every site.
</summary>
</member>
<member name="M:CMS.WebAnalytics.UTMCodeAttribute.IsValid(System.Object,System.ComponentModel.DataAnnotations.ValidationContext)">
<summary>
Checks if object is valid.
</summary>
<param name="value">Object to validate.</param>
<param name="validationContext">Validation context.</param>
</member>
<member name="T:CMS.WebAnalytics.Internal.CampaignDataGenerator">
<summary>
Contains methods for generating sample data for the Campaign module.
</summary>
<exclude />
</member>
<member name="F:CMS.WebAnalytics.Internal.CampaignDataGenerator.CAMPAIGN_CAFE_PROMOTION">
<summary>
Code name of the Cafe promotion campaign.
</summary>
</member>
<member name="F:CMS.WebAnalytics.Internal.CampaignDataGenerator.CAMPAIGN_COFFEE_CLUB_MEMBERSHIP">
<summary>
Code name of the Coffee club membership campaign.
</summary>
</member>
<member name="F:CMS.WebAnalytics.Internal.CampaignDataGenerator.CAMPAIGN_CAFE_SAMPLE_PROMOTION">
<summary>
Code name of the Cafe sample promotion campaign.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.CampaignDataGenerator.#ctor(CMS.SiteProvider.SiteInfo)">
<summary>
Constructor.
</summary>
<param name="site">Site the newsletters data will be generated for</param>
</member>
<member name="M:CMS.WebAnalytics.Internal.CampaignDataGenerator.Generate">
<summary>
Performs campaigns sample data generation.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignAssetInfo">
<summary>
CampaignAssetInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignAssetInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignAssetInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Constructor for de-serialization.
</summary>
<param name="info">Serialization info</param>
<param name="context">Streaming context</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfo.#ctor">
<summary>
Constructor - Creates an empty CampaignAssetInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new CampaignAssetInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetID">
<summary>
Campaign asset ID
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetGuid">
<summary>
Campaign asset guid
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetLastModified">
<summary>
Campaign asset last modified
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetType">
<summary>
Campaign asset type
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetAssetGuid">
<summary>
Guid of specific asset (e.g. email or form)
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignAssetInfo.CampaignAssetCampaignID">
<summary>
Campaign asset campaign ID
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignAssetInfoProvider">
<summary>
Class providing CampaignAssetInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssets">
<summary>
Returns a query for all the CampaignAssetInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssetInfo(System.Int32)">
<summary>
Returns CampaignAssetInfo with specified ID.
</summary>
<param name="id">CampaignAssetInfo ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssetInfo(System.Guid)">
<summary>
Returns CampaignAssetInfo with specified GUID.
</summary>
<param name="guid">CampaignAssetInfo GUID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.SetCampaignAssetInfo(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Sets (updates or inserts) specified CampaignAssetInfo.
</summary>
<param name="infoObj">CampaignAssetInfo to be set</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.DeleteCampaignAssetInfo(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Deletes specified CampaignAssetInfo.
</summary>
<param name="infoObj">CampaignAssetInfo to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.DeleteCampaignAssetInfo(System.Int32)">
<summary>
Deletes CampaignAssetInfo with specified ID.
</summary>
<param name="id">CampaignAssetInfo ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssetsInternal">
<summary>
Returns a query for all the CampaignAssetInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssetInfoInternal(System.Int32)">
<summary>
Returns CampaignAssetInfo with specified ID.
</summary>
<param name="id">CampaignAssetInfo ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.GetCampaignAssetInfoInternal(System.Guid)">
<summary>
Returns CampaignAssetInfo with specified GUID.
</summary>
<param name="guid">CampaignAssetInfo GUID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.SetCampaignAssetInfoInternal(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Sets (updates or inserts) specified CampaignAssetInfo.
</summary>
<param name="infoObj">CampaignAssetInfo to be set</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetInfoProvider.DeleteCampaignAssetInfoInternal(CMS.WebAnalytics.CampaignAssetInfo)">
<summary>
Deletes specified CampaignAssetInfo.
</summary>
<param name="infoObj">CampaignAssetInfo to be deleted</param>
</member>
<member name="T:CMS.WebAnalytics.CampaignService">
<summary>
Provides access to the campaign related to the current request via the implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ICampaignService">
<summary>
Provides access to the campaign related to the current request via the implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ICampaignService.SetCampaign(System.String,System.String,System.String)">
<summary>
If <see cref="T:CMS.WebAnalytics.CampaignInfo"/> with given <paramref name="campaignCode"/> exists and is running, sets both <paramref name="campaignCode"/> and <paramref name="source"/> to their
properties (<see cref="P:CMS.WebAnalytics.ICampaignService.CampaignCode"/> or <see cref="P:CMS.WebAnalytics.ICampaignService.CampaignSourceName"/> respectively).
Additionally performs logging of campaign hit to the analytics.
</summary>
<remarks>
If Javascript logging is enabled, hit logging will be performed asynchronously on the following request.
</remarks>
<param name="campaignCode">Campaign UTM code</param>
<param name="siteName">Name of the site the campaign belongs to</param>
<param name="source">Name of the campaign source</param>
<example>
Following example shows how to use the <see cref="M:CMS.WebAnalytics.ICampaignService.SetCampaign(System.String,System.String,System.String)"/> method.
<code>
var campaignService = new CampaignService();
...
// stores myCampaign to the <see cref="P:CMS.WebAnalytics.ICampaignService.CampaignCode"/> and mySource to the <see cref="P:CMS.WebAnalytics.ICampaignService.CampaignSourceName"/>
campaignService.SetCampaign("myCampaign", "mySite", "mySource");
...
// for all following requests of the same visitor
// returns myCampaign
public string GetCampaignCode()
{
return campaignService.CampaignCode;
}
// returns mySource
public string GetSourceName()
{
return campaignService.CampaignSourceName;
}
</code>
</example>
</member>
<member name="P:CMS.WebAnalytics.ICampaignService.CampaignCode">
<summary>
Gets/sets the visitor's campaign from/to a persistent storage.
</summary>
<example>
Following example shows how to use the <see cref="P:CMS.WebAnalytics.ICampaignService.CampaignCode"/> property in the case <see cref="T:CMS.WebAnalytics.CookieCampaignPersistentStorage"/> is used as implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
<code>
var campaignService = new CampaignService();
...
// for request with cookie Campaign: test_campaign returns test_campaign
// for request without cookies returns null
public string GetCampaignCode()
{
return campaignService.CampaignCode;
}
</code>
</example>
</member>
<member name="P:CMS.WebAnalytics.ICampaignService.CampaignSourceName">
<summary>
Gets/sets the visitor's source from/to a cookie.
</summary>
<example>
Following example shows how to use the <see cref="P:CMS.WebAnalytics.ICampaignService.CampaignSourceName"/> property in the case <see cref="T:CMS.WebAnalytics.CookieCampaignPersistentStorage"/> is used as implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
<code>
var campaignService = new CampaignService();
...
// for request with cookie Source: test_source returns test_source
// for request without cookies returns null
public string GetSourceName()
{
return campaignService.CampaignSourceName;
}
</code>
</example>
</member>
<member name="M:CMS.WebAnalytics.CampaignService.#ctor(CMS.WebAnalytics.ICampaignPersistentStorage)">
<summary>
Creates new instance of <see cref="T:CMS.WebAnalytics.CampaignService"/>.
</summary>
<param name="campaignPersistentStorage">Provides access to the persistent storage of campaign and campaign source name.</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignService.SetCampaign(System.String,System.String,System.String)">
<summary>
If <see cref="T:CMS.WebAnalytics.CampaignInfo"/> with given <paramref name="campaignCode"/> exists and is running, sets both <paramref name="campaignCode"/> and <paramref name="source"/> to their
properties (<see cref="P:CMS.WebAnalytics.CampaignService.CampaignCode"/> or <see cref="P:CMS.WebAnalytics.CampaignService.CampaignSourceName"/> respectively).
Additionally performs logging of campaign hit to the analytics.
</summary>
<remarks>
If Javascript logging is enabled, hit logging will be performed asynchronously on the following request.
</remarks>
<param name="campaignCode">Name of the campaign to be set</param>
<param name="siteName">Name of the site the <paramref name="campaignCode"/> belongs to</param>
<param name="source">Name of the campaign source</param>
<example>
Following example shows how to use the <see cref="M:CMS.WebAnalytics.CampaignService.SetCampaign(System.String,System.String,System.String)"/> method.
<code>
var campaignService = new CampaignService();
...
// stores myCampaign to the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignCode"/> and mySource to the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignSourceName"/>
campaignService.SetCampaign("myCampaign", "mySite", "mySource");
...
// for all following requests of the same visitor
// returns myCampaign
public string GetCampaignCode()
{
return campaignService.CampaignCode;
}
// returns mySource
public string GetSourceName()
{
return campaignService.CampaignSourceName;
}
</code>
</example>
<exception cref="T:System.ArgumentException"><paramref name="campaignCode"/> is null -or- <paramref name="siteName"/> is null or empty</exception>
</member>
<member name="P:CMS.WebAnalytics.CampaignService.CampaignCode">
<summary>
Gets/sets the visitor's campaign from/to a persistent storage.
</summary>
<example>
Following example shows how to use the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignCode"/> property in the case <see cref="T:CMS.WebAnalytics.CookieCampaignPersistentStorage"/> is used as implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
<code>
var campaignService = new CampaignService();
...
// for request with cookie Campaign: test_campaign returns test_campaign
// for request without cookies returns null
public string GetCampaignCode()
{
return campaignService.CampaignCode;
}
</code>
</example>
</member>
<member name="P:CMS.WebAnalytics.CampaignService.CampaignSourceName">
<summary>
Gets/sets the visitor's source from/to a cookie.
</summary>
<example>
Following example shows how to use the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignSourceName"/> property in the case <see cref="T:CMS.WebAnalytics.CookieCampaignPersistentStorage"/> is used as implementation of <see cref="T:CMS.WebAnalytics.ICampaignPersistentStorage"/>.
<code>
var campaignService = new CampaignService();
...
// for request with cookie Source: test_source returns test_source
// for request without cookies returns null
public string GetSourceName()
{
return campaignService.CampaignSourceName;
}
</code>
</example>
</member>
<member name="T:CMS.WebAnalytics.CookieCampaignPersistentStorage">
<summary>
Provides access to the campaign and its source name stored in the cookies.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ICampaignPersistentStorage">
<summary>
Provides access to storing and retrieving campaign code and campaign source name from/to persistent storage.
Persistent storage is a place where campaign code and source name can be stored and after the same visitor
makes another request, it will be returned.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ICampaignPersistentStorage.CampaignUTMCode">
<summary>
Campaign UTM code.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ICampaignPersistentStorage.SourceName">
<summary>
Name of the campaign's source name.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CookieCampaignPersistentStorage.EnsureCampaign(System.String)">
<summary>
Ensures that given <paramref name="campaignCode"/> represents existing <see cref="T:CMS.WebAnalytics.CampaignInfo"/> and the related <see cref="T:CMS.WebAnalytics.CampaignInfo"/> is not finished.
</summary>
<param name="campaignCode">Campaign UTM code.</param>
<returns>True if campaign exists and has not finished yet; otherwise, false</returns>
</member>
<member name="M:CMS.WebAnalytics.CookieCampaignPersistentStorage.RemoveCampaignCookies">
<summary>
Removes all cookies related to the campaign.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CookieCampaignPersistentStorage.CampaignUTMCode">
<summary>
Gets or sets the visitor's campaign from/to a cookie.
</summary>
<remarks>
The cookie is saved when a visitor comes to the page through URL that contains campaign parameter. Is stored for fifty years and is used for linking campaigns to conversions.
</remarks>
</member>
<member name="P:CMS.WebAnalytics.CookieCampaignPersistentStorage.SourceName">
<summary>
Gets or sets the visitor's source from/to a cookie.
</summary>
<remarks>
The cookie is saved when a visitor comes to the page through URL that contains source parameter. Is stored for fifty years and is used for linking channels to conversions.
</remarks>
</member>
<member name="T:CMS.WebAnalytics.ITrackedCampaignsService">
<summary>
Provides access to the tracked campaigns.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ITrackedCampaignsService.AddTrackedCampaign(System.String)">
<summary>
Adds new campaign to TrackedCampaigns collection. Adding is performed only when campaign is not already present.
</summary>
<param name="campaignName">Codename of campaign</param>
</member>
<member name="M:CMS.WebAnalytics.ITrackedCampaignsService.RemoveTrackedCampaigns">
<summary>
Removes TrackedCampaign cookie from cookie collection.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ITrackedCampaignsService.TrackedCampaigns">
<summary>
Gets enumerable of campaigns which should be logged in web analytics service called by Javascript.
</summary>
</member>
<member name="T:CMS.WebAnalytics.DateTimePickerSettingsProvider">
<summary>
Provides dictionary containing all culture dependent settings needed for initialization of cmsdatepicker javascript component.
</summary>
</member>
<member name="T:CMS.WebAnalytics.IDateTimePickerSettingsProvider">
<summary>
Provides dictionary containing all culture dependent settings needed for initialization of cmsdatepicker javascript component.
</summary>
</member>
<member name="M:CMS.WebAnalytics.IDateTimePickerSettingsProvider.GetDateTimePickerSettings(System.Globalization.CultureInfo,CMS.SiteProvider.SiteInfo,System.DateTime)">
<summary>
Get dictionary containing all culture dependent settings needed by cmsdatepicker component, as well as timezone dependent labels.
</summary>
<param name="culture">Culture for which the settings will be evaluated</param>
<param name="currentSite">Reference to the executing site. This information is needed, because current time for the datepicker is retrieved based on the site time zone</param>
<param name="currentDateTime">Current date time for the site. Should be already shifted by timezone, if necessary</param>
<returns>Settings object suitable for serialization</returns>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.#ctor(CMS.Core.ILocalizationService)">
<summary>
Constructor, creates instance of <see cref="T:CMS.WebAnalytics.DateTimePickerSettingsProvider"/>.
</summary>
<param name="localizationService">Service for strings localization</param>
<example>
This example shows how to use the settings when calling angular cms-date-time-picker component.
<code>
service.cs
var settingsProvider = new DateTimePickerSettingsProvider(localizationService);
var settings = JsonConvert.SerializeObject(settingsProvider.GetDateTimePickerSettings(culture, currentDateTime));
... pass settings to the client
controller.js
$scope.settings = getSettingsFromServer();
markup.aspx
<cms-date-time-picker settings="{{settings}}"></cms-date-time-picker>
</code>
</example>
<exception cref="T:System.ArgumentNullException"><paramref name="localizationService"/> is null</exception>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.GetDateTimePickerSettings(System.Globalization.CultureInfo,CMS.SiteProvider.SiteInfo,System.DateTime)">
<summary>
Get dictionary containing all culture dependent settings needed by cmsdatepicker component, as well as timezone dependent labels.
</summary>
<param name="culture">Culture for which the settings will be evaluated</param>
<param name="currentSite">Reference to the executing site. This information is needed, because current time for the datepicker is retrieved based on the site time zone</param>
<param name="currentDateTime">Current date time for the site. Should be already shifted by timezone, if necessary</param>
<remarks>
Settings are suitable for serialization using Newtonsoft.Json. For example, please refer to <see cref="T:CMS.WebAnalytics.DateTimePickerSettingsProvider"/>.
This service is directly dependent on the <see cref="T:CMS.Globalization.TimeZoneHelper"/> class.
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="culture"/> or <paramref name="currentSite"/> is null</exception>
<returns>Settings object suitable for serialization</returns>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddMonthNames(System.Collections.Generic.Dictionary{System.String,System.Object},System.Globalization.DateTimeFormatInfo)">
<summary>
Add values representing the month names.
</summary>
<remarks>
Default monthNames for en-US culture are <c>January, February, ...</c>.
Default monthNamesShort for en-US culture are <c>Jan, Feb, ...</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="dateTimeFormatInfo">Provides culture-specific information about the format of date and time values</param>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddDayNames(System.Collections.Generic.Dictionary{System.String,System.Object},System.Globalization.DateTimeFormatInfo)">
<summary>
Adds values representing the day names and flag determining which day starts the week.
</summary>
<remarks>
Default dayNames for en-US culture are <c>Sunday, Monday, ...</c>.
Default dayNamesMin for en-US culture are <c>Su, Mo, ...</c>.
Default firstDay for en-US culture is <c>0</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="dateTimeFormatInfo">Provides culture-specific information about the format of date and time values</param>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddHourDesignators(System.Collections.Generic.Dictionary{System.String,System.Object},System.Globalization.CultureInfo)">
<summary>
Adds text representing the ante and poste meridiem suffixes.
</summary>
<remarks>
Default AMDesignator for en-US culture is <c>AM</c>.
Default PMDesignator for en-US culture is <c>PM</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="culture">Provides information about culture context</param>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddButtonsText(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
<summary>
Adds texts that will be rendered on various buttons within the calendar control.
</summary>
<remarks>
Default closeText for en-US culture is <c>Select</c>.
Default prevText for en-US culture is <c>Prev</c>.
Default nextText for en-US culture is <c>Next</c>.
Default NAText for en-US culture is <c>N/A</c>.
Default currentText for en-US culture is <c>Now</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="cultureCode">The culture name in the format languagecode2-country/regioncode2</param>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddRTLFlag(System.Collections.Generic.Dictionary{System.String,System.Object},System.Globalization.CultureInfo)">
<summary>
Adds flag determining whether right-to-left rendering should be used.
</summary>
<remarks>
Default isRTL for en-US culture is <c>false</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="culture">Provides information about culture context</param>
</member>
<member name="M:CMS.WebAnalytics.DateTimePickerSettingsProvider.AddDateFormattingAndCurrentDate(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Globalization.CultureInfo,System.DateTime)">
<summary>
Adds date formatting and flag determining whether 24 hour format is used for the time.
</summary>
<remarks>
Default dateFormat for en-US culture is <c>M/d/yy h:mm:ss tt</c>.
Default use24HourMode for en-US culture is <c>false</c>.
</remarks>
<param name="dictionary">Settings dictionary</param>
<param name="dateFormat">Specifies how the date will be formatted</param>
<param name="culture">Provides information about culture context</param>
<param name="currentDateTime">Current date time for the site. Should be already shifted by timezone, if necessary</param>
</member>
<member name="T:CMS.WebAnalytics.TrackedCampaignsService">
<summary>
Provides access to the tracked campaigns.
</summary>
</member>
<member name="M:CMS.WebAnalytics.TrackedCampaignsService.AddTrackedCampaign(System.String)">
<summary>
Adds new campaign to TrackedCampaigns collection. Adding is performed only when campaign is not already present.
</summary>
<param name="campaignName">Codename of campaign</param>
</member>
<member name="M:CMS.WebAnalytics.TrackedCampaignsService.RemoveTrackedCampaigns">
<summary>
Removes TrackedCampaign cookie from cookie collection.
</summary>
</member>
<member name="P:CMS.WebAnalytics.TrackedCampaignsService.TrackedCampaigns">
<summary>
Gets enumerable of campaigns which should be logged in web analytics service called by Javascript.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ConversionCampaignSourceInfo">
<summary>
ConversionCampaignSourceInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ConversionCampaignSourceInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.ConversionCampaignSourceInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Constructor for de-serialization.
</summary>
<param name="info">Serialization info</param>
<param name="context">Streaming context</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfo.#ctor">
<summary>
Constructor - Creates an empty ConversionCampaignSourceInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new ConversionCampaignSourceInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="P:CMS.WebAnalytics.ConversionCampaignSourceInfo.ConversionCampaignSourceID">
<summary>
Conversion campaign source ID
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionCampaignSourceInfo.CampaignID">
<summary>
Campaign ID
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionCampaignSourceInfo.ConversionID">
<summary>
Conversion ID
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionCampaignSourceInfo.SourceName">
<summary>
Source name
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionCampaignSourceInfo.ConversionHits">
<summary>
Conversion hits
</summary>
</member>
<member name="T:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider">
<summary>
Class providing ConversionCampaignSourceInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.GetConversionCampaignSources">
<summary>
Returns all ConversionCampaignSourceInfo bindings.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.GetConversionCampaignSources(System.Int32)">
<summary>
Returns all ConversionCampaignSourceInfo bindings with campaignID.
</summary>
<param name="campaignId">Campaign ID</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.SetConversionCampaignSourceInfo(CMS.WebAnalytics.ConversionCampaignSourceInfo)">
<summary>
Sets specified ConversionCampaignSourceInfo.
</summary>
<param name="infoObj">ConversionCampaignSourceInfo to set</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.DeleteConversionCampaignSourceInfo(CMS.WebAnalytics.ConversionCampaignSourceInfo)">
<summary>
Deletes specified ConversionCampaignSourceInfo binding.
</summary>
<param name="infoObj">ConversionCampaignSourceInfo object</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.SetConversionCampaignSourceInfoInternal(CMS.WebAnalytics.ConversionCampaignSourceInfo)">
<summary>
Sets specified ConversionCampaignSourceInfo binding.
</summary>
<param name="infoObj">ConversionCampaignSourceInfo object</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.DeleteConversionCampaignSourceInfoInternal(CMS.WebAnalytics.ConversionCampaignSourceInfo)">
<summary>
Deletes specified ConversionCampaignSourceInfo.
</summary>
<param name="infoObj">ConversionCampaignSourceInfo object</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionCampaignSourceInfoProvider.BulkInsertUTMData(System.Collections.Generic.IList{CMS.WebAnalytics.ConversionCampaignSourceInfo})">
<summary>
Inserts multiple log records to the database.
</summary>
<param name="utmParameters">UTM records to insert</param>
</member>
<member name="T:CMS.WebAnalytics.CampaignStatusEnum">
<summary>
Represents the current status of a campaign.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignStatusEnum.Launched">
<summary>
Campaign have been launched and currently running. All data will be tracked.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignStatusEnum.Scheduled">
<summary>
Campaign is scheduled to be launched in the future. No data are tracked until launched.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignStatusEnum.Draft">
<summary>
Campaign is not enabled and not ready to be started yet.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignStatusEnum.Finished">
<summary>
Campaign has finished. No data are tracked.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignLaunchLogHandler">
<summary>
Handler for campaign launch collects messages of actions.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignLaunchedHandler">
<summary>
Handler for campaign being launched.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignLaunchLogEventArgs">
<summary>
Arguments for event handlers related to <see cref="T:CMS.WebAnalytics.CampaignLaunchLogHandler"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignLaunchLogEventArgs.Campaign">
<summary>
Campaign info.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignLaunchLogEventArgs.Messages">
<summary>
Messages for all actions.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignUTMChangedEventArgs">
<summary>
Arguments for event handlers related to <see cref="T:CMS.WebAnalytics.CampaignUTMChangedHandler"/>.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignUTMChangedEventArgs.OriginalEmailID">
<summary>
ID of issue (for A/B must be master email ID).
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignUTMChangedEventArgs.Campaign">
<summary>
Campaign info.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignUTMChangedEventArgs.NewUTMSource">
<summary>
New UTM source to set.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignUTMChangedHandler">
<summary>
Fires when there is a change in campaigns UTM parameter.
</summary>
</member>
<member name="T:CMS.WebAnalytics.Filters.FilterCrawlersAttribute">
<summary>
Checks whether the request was made by crawler. If so, returns 403 Forbidden message.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Filters.FilterCrawlersAttribute.OnAuthorization(System.Web.Http.Controllers.HttpActionContext)">
<summary>
Calls when a process requests authorization.
</summary>
<param name="actionContext">The action context, which encapsulates information for using <see cref="T:System.Web.Http.Filters.AuthorizationFilterAttribute"/>.</param>
</member>
<member name="T:CMS.WebAnalytics.ILogHitsProvider">
<summary>
Defines methods which have to be implemented in order to be able to perform logging of visitor hits.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ILogHitsProvider.LogHit(CMS.WebAnalytics.LogHitParameters)">
<summary>
Performs logging of general hit.
</summary>
<param name="logHitParameters">Parameters required for hit logging</param>
<exception cref="T:System.ArgumentException">Attempt to found page according to the given <paramref name="logHitParameters"/> was not successful (no page was found).</exception>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="logHitParameters"/> is null</exception>
</member>
<member name="M:CMS.WebAnalytics.ILogHitsProvider.LogBannerHit(System.Int32)">
<summary>
Performs logging of banner hit.
</summary>
<param name="bannerID">ID of the banner the visitor clicked on</param>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
</member>
<member name="M:CMS.WebAnalytics.ILogHitsProvider.LogSearchHit(CMS.WebAnalytics.LogSearchHitParameters)">
<summary>
Performs logging of search event hit.
</summary>
<param name="logSearchHitParameters">Parameters required for hit logging</param>
<exception cref="T:System.ArgumentException">Attempt to found page according to the given <paramref name="logSearchHitParameters"/> was not successful (no page was found).</exception>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="logSearchHitParameters"/> is null</exception>
</member>
<member name="T:CMS.WebAnalytics.LogHitParameters">
<summary>
Data class containing all fields required for asynchronous hit logging.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.UrlReferrer">
<summary>
Current request referrer.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.NodeAliasPath">
<summary>
Alias path to the document from which was the request made.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.DocumentCultureCode">
<summary>
Culture of the document from which was the request made.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.ABTestName">
<summary>
Name of the AB test to log visit for.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.ABTestVariantName">
<summary>
Name of the currently selected AB test variant.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.ABTestFirstVisit">
<summary>
Decides whether to log first visit or recurring visit for given AB test.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.MVTestCombinationName">
<summary>
Name of the MV test combination to log visit for.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogHitParameters.PlainParameters">
<summary>
Wrapper around the other fields. This field is used as argument when raising log hit event.
</summary>
<remarks>
Keys in dictionary do not match the fields name due to backward compatibility.
</remarks>
</member>
<member name="T:CMS.WebAnalytics.LogSearchHitParameters">
<summary>
Data class containing all fields required for asynchronous search hit logging.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogSearchHitParameters.Keyword">
<summary>
Keyword representing the search query made by search engine.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogSearchHitParameters.NodeAliasPath">
<summary>
Alias path to the document from which was the request made.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogSearchHitParameters.DocumentCultureCode">
<summary>
Culture of the document from which was the request made.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ApiControllers.WebAnalyticsController">
<summary>
Handles logging of visitor hits.
</summary>
<remarks>
Only real visitors ban be logged, crawlers which the system is able to recognize are omitted.
Adds information to the header to tell the crawlers not to track this controller. This applies only to the crawlers that was
not recognized in the <see cref="T:CMS.WebAnalytics.Filters.FilterCrawlersAttribute"/>.
</remarks>
</member>
<member name="M:CMS.WebAnalytics.ApiControllers.WebAnalyticsController.LogHit(CMS.WebAnalytics.LogHitParameters)">
<summary>
Performs logging of general hit.
</summary>
<param name="logHitParameters">Parameters required for hit logging</param>
<returns>
HTTP response message containing the status code dependent on whether the action was successful or not.
Returns 200 OK status if logging was successful.
Returns 400 Bad request if exception was thrown while trying to log the hit.
</returns>
</member>
<member name="M:CMS.WebAnalytics.ApiControllers.WebAnalyticsController.LogSearchHit(CMS.WebAnalytics.LogSearchHitParameters)">
<summary>
Performs logging of search event hit.
</summary>
<param name="logSearchHitParameters">Parameters required for hit logging</param>
<returns>
HTTP response message containing the status code dependent on whether the action was successful or not.
Returns 200 OK status if logging was successful.
Returns 400 Bad request if exception was thrown while trying to log the hit.
</returns>
</member>
<member name="M:CMS.WebAnalytics.ApiControllers.WebAnalyticsController.LogBannerHit(System.Int32)">
<summary>
Performs logging of banner hit.
</summary>
<param name="bannerID">ID of the banner the visitor clicked on</param>
<returns>
HTTP response message containing the status code dependent on whether the action was successful or not.
Returns 200 OK status if logging was successful.
Returns 400 Bad request if exception was thrown while trying to log the hit.
</returns>
</member>
<member name="T:CMS.WebAnalytics.Filters.DoNotTrackAttribute">
<summary>
Adds header to the response telling the crawlers not to track the site the request was made for.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Filters.DoNotTrackAttribute.OnActionExecuted(System.Web.Http.Filters.HttpActionExecutedContext)">
<summary>
Occurs after the action method is invoked.
</summary>
<param name="actionExecutedContext">The action executed context.</param>
</member>
<member name="T:CMS.WebAnalytics.UserNameFormatter">
<summary>
Translates <see cref="T:CMS.Membership.UserInfo"/> to human readable format.
</summary>
</member>
<member name="M:CMS.WebAnalytics.UserNameFormatter.GetFriendlyUserName(System.Int32)">
<summary>
Joins user name consisting of first, middle, last and e-mail address in one string.
</summary>
<param name="userId">User ID</param>
</member>
<member name="M:CMS.WebAnalytics.UserNameFormatter.GetFriendlyUserName(CMS.Membership.UserInfo)">
<summary>
Joins user name consisting of first, middle, last and e-mail address in one string.
</summary>
<param name="ui">User info</param>
</member>
<member name="M:CMS.WebAnalytics.UserNameFormatter.GetFriendlyUserName(CMS.DataEngine.BaseInfo)">
<summary>
Joins user name consisting of first, middle, last and e-mail address in one string.
</summary>
<param name="ui">User info</param>
</member>
<member name="M:CMS.WebAnalytics.UserNameFormatter.GetFriendlyUserName(System.String,System.String,System.String,System.String,System.String)">
<summary>
Joins user name consisting of first, middle, last and e-mail address in one string.
</summary>
<param name="first">First name</param>
<param name="middle">Middle name</param>
<param name="last">Last name</param>
<param name="emailAddress">E-mail address</param>
<param name="userName">User name</param>
</member>
<member name="T:CMS.WebAnalytics.MembershipType">
<summary>
Membership type constants
</summary>
</member>
<member name="F:CMS.WebAnalytics.MembershipType.CMS_USER">
<summary>
Regular user
</summary>
</member>
<member name="F:CMS.WebAnalytics.MembershipType.ECOMMERCE_CUSTOMER">
<summary>
Ecommerce customer
</summary>
</member>
<member name="F:CMS.WebAnalytics.MembershipType.NEWSLETTER_SUBSCRIBER">
<summary>
Newsletter subscriber
</summary>
</member>
<member name="T:CMS.WebAnalytics.ActivityContext">
<summary>
Activity environment variables.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.ContactID">
<summary>
Current contact ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.SiteID">
<summary>
Current site ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.Campaign">
<summary>
Current campaign.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.IsLiveSite">
<summary>
Indicates if activity occurred on live site.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.CurrentUser">
<summary>
Current user info.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.DocumentLogActivity">
<summary>
Indicates if document enables logging activity.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.CurrentHttpContext">
<summary>
Current HTTP context.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.CurrentURL">
<summary>
Gets or sets the Url which user visited.
</summary>
<remarks>
When activities are logged through WebAnalytics service, this property is set to the referrer,
because that is the actual page which should be logged.
</remarks>
<value>Can be either set manually, or obtained from RequestContext otherwise</value>
</member>
<member name="P:CMS.WebAnalytics.ActivityContext.CurrentURLReferrer">
<summary>
Gets or sets current URL referrer.
</summary>
<value>Can be either set manually, or obtained from HttpContext otherwise</value>
</member>
<member name="T:CMS.WebAnalytics.DefaultLogHitsProvider">
<summary>
Default implementation of <see cref="T:CMS.WebAnalytics.ILogHitsProvider"/>. Contains methods for performing logging of visitor hits.
</summary>
</member>
<member name="M:CMS.WebAnalytics.DefaultLogHitsProvider.LogHit(CMS.WebAnalytics.LogHitParameters)">
<summary>
Performs logging of general hit.
</summary>
<param name="logHitParameters">Parameters required for hit logging</param>
<exception cref="T:System.ArgumentException">Attempt to found page according to the given <paramref name="logHitParameters"/> was not successful (no page was found).</exception>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="logHitParameters"/> is null</exception>
</member>
<member name="M:CMS.WebAnalytics.DefaultLogHitsProvider.LogBannerHit(System.Int32)">
<summary>
Performs logging of banner hit.
</summary>
<param name="bannerID">ID of the banner the visitor clicked on</param>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
</member>
<member name="M:CMS.WebAnalytics.DefaultLogHitsProvider.LogSearchHit(CMS.WebAnalytics.LogSearchHitParameters)">
<summary>
Performs logging of search event hit.
</summary>
<param name="logSearchHitParameters">Parameters required for hit logging</param>
<exception cref="T:System.ArgumentException">Attempt to found page according to the given <paramref name="logSearchHitParameters"/> was not successful (no page was found).</exception>
<exception cref="T:System.InvalidOperationException">Javascript logging is not enabled on the current site.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="logSearchHitParameters"/> is null</exception>
</member>
<member name="T:CMS.WebAnalytics.AnalyticsDebug">
<summary>
Analytics debug methods
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsDebug.GetDebugSettings">
<summary>
Gets the debug settings
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsDebug.NewLogTable">
<summary>
Creates a new table for the analytics log.
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsDebug.LogAnalyticsOperation(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Double)">
<summary>
Logs the analytics operation. Logs the analytics operation to the file and to current request log for debugging.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="count">Hit count</param>
<param name="value">Hit value</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsDebug.LogToFile(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Double)">
<summary>
Logs the analytics operation to the log file.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="count">Hit count</param>
<param name="value">Hit value</param>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsDebug.Settings">
<summary>
Debug settings
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsDebug.CurrentRequestLog">
<summary>
Current request log.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsDebug.DebugCurrentRequest">
<summary>
Debug current request Analytics access.
</summary>
</member>
<member name="T:CMS.WebAnalytics.AnalyticsHelper">
<summary>
Analytics helper class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.SUBSCRIPTION_WINDOW_WIDTH">
<summary>
Width of subscription window
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.SUBSCRIPTION_WINDOW_HEIGHT">
<summary>
Height of subscription window
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.MANAGE_WINDOW_WIDTH">
<summary>
Width of manage data window
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.MANAGE_WINDOW_HEIGHT">
<summary>
Height of manage data window
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.PARAM_SEMICOLON">
<summary>
Replacement for the semicolon character used in the url parameter
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.mSiteList">
<summary>
Hashtable of sorted dictionaries of lists with visitors IP addresses
HashTable[ siteName -> { lastTime, ArrayList of Hashtable[IP -> true] } ]
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.mIPsRegExpTable">
<summary>
Hashtable of regular expressions of sites' excluded IPs.
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.mSlidingIPExpiration">
<summary>
Indicates if IP should be logged every time for anonymous user.
</summary>
</member>
<member name="F:CMS.WebAnalytics.AnalyticsHelper.mIpLocker">
<summary>
Locking object for list of IP addresses per site
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.JavascriptLoggingEnabled(System.String)">
<summary>
Returns "Use JavaScript logging" value from the database.
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.ExcludedIPs(System.String)">
<summary>
Returns "Excluded IPs" value from the database.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.ExcludedURLs(System.String)">
<summary>
Returns "Excluded URLs" value from the database.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.ExcludedFileExtensions(System.String)">
<summary>
Returns "Excluded file extensions" value from the database.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.ExcludeSearchEngines(System.String)">
<summary>
Returns "Exclude search engines" value from the database.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.AnalyticsEnabled(System.String)">
<summary>
Returns true if web analytics is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackPageViewsEnabled(System.String)">
<summary>
Returns true if page views tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackAggregatedViewsEnabled(System.String)">
<summary>
Returns true if aggregated views tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackVisitsEnabled(System.String)">
<summary>
Returns true if visits tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.VisitorsSmartCheckingTime(System.String)">
<summary>
Returns how long should be visitors' IP addresses stored in memory.
Visitors smart checking is disabled if 0 is returned.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackFileDownloadsEnabled(System.String)">
<summary>
Returns true if file downloads tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackBrowserTypesEnabled(System.String)">
<summary>
Returns true if browser types tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackInvalidPagesEnabled(System.String)">
<summary>
Returns true if invalid pages tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackSearchKeywordsEnabled(System.String)">
<summary>
Returns true if search keywords tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackLandingPageEnabled(System.String)">
<summary>
Returns true if landing page tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackExitPageEnabled(System.String)">
<summary>
Returns true if exit page tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackSearchEnginesEnabled(System.String)">
<summary>
Returns true if search engine tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackSearchCrawlersEnabled(System.String)">
<summary>
Returns true if search crawlers tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackReferralsEnabled(System.String)">
<summary>
Returns true if referrals tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackCountriesEnabled(System.String)">
<summary>
Returns true if countries tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackRegisteredUsersEnabled(System.String)">
<summary>
Returns true if registered users tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackOnSiteKeywords(System.String)">
<summary>
Returns true if onsite keywords tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackReferringSitesDirect(System.String)">
<summary>
Returns true if referring sites direct link tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackReferringSitesLocal(System.String)">
<summary>
Returns true if referring sites by local links tracking is enabled for specified site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackAverageTimeOnPage(System.String)">
<summary>
Returns true if average time on page tracking is enabled
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackReferringSitesReferring(System.String)">
<summary>
Returns true if referring sites by other domain tracking is enabled for specific site.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackMobileDevicesEnabled(System.String)">
<summary>
Returns true if mobile device tracking is enabled
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.GetVisitorStatusIdle(System.String)">
<summary>
Gets or sets the value in minutes for how long user should be counted as active(1380 minutes by default = 23 hours).
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.GetContextStatus(System.String,System.Boolean@)">
<summary>
Returns current visitor status
</summary>
<param name="siteName">Site name</param>
<param name="idleExpired">Indicates whether idle expired</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TryGetStatusBackwardCompatible(System.Boolean@)">
<summary>
Tries get status from previous type of cookies
</summary>
<param name="idleExpired">Indicates whether idle expired</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.CleanIPAdresses(System.String)">
<summary>
Cleans list of IP addresses from site list
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.SetupIPExpiration(System.String)">
<summary>
Sets up the IP expiration
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.SetContextStatus(System.String,CMS.WebAnalytics.VisitorStatusEnum,System.DateTime)">
<summary>
Sets context status.
</summary>
<param name="siteName">Name of context's site</param>
<param name="status">Visitor's status</param>
<param name="lastActivityDate">Date time of visitor's last activity</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsLoggingEnabled(System.String,System.String)">
<summary>
Return true if analytics log enabled for given data
</summary>
<param name="siteName">Site name</param>
<param name="nodeAliasPath">Node alias path</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsLoggingEnabled(System.String,System.String,CMS.WebAnalytics.LogExcludingFlags)">
<summary>
Return true if analytics log enabled for given data
</summary>
<param name="siteName">Site name</param>
<param name="nodeAliasPath">Node alias path</param>
<param name="excludingOptions">Excluding options flag for logging</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsIPExcluded(System.String,System.String)">
<summary>
Determines whether IP is excluded or not.
</summary>
<param name="siteName">Site name</param>
<param name="ip">IP</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.GetQueryStringParameters(System.Data.DataRow)">
<summary>
Generates reports parameters for query string
</summary>
<param name="dr">Datarow with report's parameters</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsURLExcluded(System.String,System.String)">
<summary>
Determines whether URL is excluded or not.
</summary>
<param name="siteName">Site name</param>
<param name="relativeUrl">URL</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsFileExtensionExcluded(System.String,System.String)">
<summary>
Determines whether extension is excluded or not.
</summary>
<param name="siteName">Site name</param>
<param name="extension">File extension (with or without '.', e.g. 'txt' or '.txt')</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.IsSearchEngineExcluded(System.String)">
<summary>
Returns true if current request is search engine and should be excluded from the analytics log.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.CurrentCampaign">
<summary>
Returns the name of the current campaign.
</summary>
<remarks>
Name of current campaign is obtained from query string.
</remarks>
<returns>Name of the campaign or null when campaign parameter is not present in query string</returns>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.CurrentSource">
<summary>
Returns the name of the current source.
</summary>
<remarks>
Name of current source is obtained from query string.
</remarks>
<returns>Name of the source or null when campaign parameter is not present in query string</returns>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.SetCampaign(System.String,System.String,System.String)">
<summary>
Creates log with current campaign or write campaign into cookie, if Javascript logging is enabled. Cookie will be used for logging using web analytics service.
</summary>
<param name="campaign">Campaign name</param>
<param name="siteName">Site name</param>
<param name="source">Channel name</param>
<returns>True if successfully logged, or campaign is written into cookie</returns>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.AddTrackedCampaign(System.String)">
<summary>
Adds new campaign to TrackedCampaigns collection. Adding is performed only when campaign is not already present.
</summary>
<param name="campaign">Codename of campaign</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.RemoveTrackedCampaigns">
<summary>
Removes TrackedCampaign cookie from cookie collection.
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogRegisteredUser(System.String,CMS.Membership.UserInfo)">
<summary>
Logs registered user to the statistics.
</summary>
<param name="siteName">Site name</param>
<param name="ui">UserInfo of registered user - username and userid of user is logged</param>
<exception cref="T:System.ArgumentNullException">Argument ui cannot be null</exception>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogSearchKeywords(System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs keywords.
</summary>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document's culture</param>
<param name="searchKeywords">Keywords to lock</param>
<param name="objectID">Object ID</param>
<param name="count">Count of keywords to log</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogAverageTimeOnPage(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Logs average time on page
</summary>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document's culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of logged items</param>
<param name="seconds">Time spent on given page</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogExitPageCandidate(System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs exit page candidate
</summary>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document's culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of logged items</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogExitPage(System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs exit page
</summary>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document's culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of logged items</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogOnSiteSearchKeywords(System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs onsite search keywords.
</summary>
<param name="siteName">Site name</param>
<param name="aliasPath">Node alias path (path with results webpart)</param>
<param name="documentCulture">Document's culture code</param>
<param name="keywords">Keywords to log</param>
<param name="objectID">Object ID</param>
<param name="count">Count to log</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogLandingPage(System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs landing page.
</summary>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document's culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of keywords to log</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogSearchCrawler(System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Logs crawler visits
</summary>
<param name="siteName">Site name to log</param>
<param name="nodeAliasPath">Node alias path</param>
<param name="documentCulture">Document's culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of keywords to log</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogReferringSite(System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Track traffic sources (used by search engines, direct url, inner site links..).
</summary>
<param name="codeName">Type of referring site</param>
<param name="siteName">Site name to log</param>
<param name="documentCulture">Document culture</param>
<param name="objectName">Object name</param>
<param name="objectID">Object ID</param>
<param name="count">Count of views</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackRegisteredUserConversion(System.String,System.Double,System.String,CMS.Membership.UserInfo)">
<summary>
Tracks registered user conversion.
</summary>
<param name="trackConversionName">Conversion name</param>
<param name="conversionCount">Value of tracked conversion</param>
<param name="siteName">Site name</param>
<param name="ui">User info</param>
<exception cref="T:System.ArgumentException">Thrown when conversion name is empty</exception>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.GetVisitorStatusByIP(System.String,System.String,System.Boolean@)">
<summary>
Returns visitor status by IP visit
</summary>
<param name="ip">IP address</param>
<param name="siteName">Site name</param>
<param name="idleExpired">Indicates whether idle time expired</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogIPVisit(System.String,System.String)">
<summary>
Logs given IP address to the IP table
</summary>
<param name="ip">IP address</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.LogIPVisit(System.String,System.String,System.DateTime)">
<summary>
Logs given IP address to the IP table
</summary>
<param name="ip">IP address</param>
<param name="siteName">Site name</param>
<param name="lastActivityDate">DateTime corresponding to the last activity date</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsHelper.TrackUserRegistration(System.String,CMS.Membership.UserInfo,System.String,System.Double)">
<summary>
Logs user registration into the web analytics and if conversion name and value are set, the conversion is tracked.
</summary>
<param name="siteName">Site name.</param>
<param name="user">Registered user.</param>
<param name="conversionName">Name of the conversion which shall be tracked. If null or empty, conversion is not tracked.</param>
<param name="conversionValue">Conversion value.</param>
<exception cref="T:System.ArgumentNullException">Argument user cannot be null</exception>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.SiteList">
<summary>
Hashtable of sorted dictionaries of lists with visitors IP addresses
HashTable[ siteName -> { lastTime, ArrayList of Hashtable[IP -> true] } ]
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.IPsRegExpTable">
<summary>
Hashtable of regular expressions of sites' excluded IPs.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.VisitorStatus">
<summary>
Returns visitor status.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.RemoveReferralQuery">
<summary>
Returns true, if query string should be removed from the referral URL; otherwise, false.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.SlidingIPExpiration">
<summary>
Returns true if IP for anonymous visitor should be logged every time.
Returns false if IP should be logged only once per user visit.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.Campaign">
<summary>
Gets/sets the visitor's campaign from/to a cookie.
</summary>
<remarks>
The cookie is saved when a visitor comes to the page through URL that contains campaign parameter. Is stored for fifty years and is used for linking campaigns to conversions.
</remarks>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.Source">
<summary>
Gets/sets the visitor's source from/to a cookie.
</summary>
<remarks>
The cookie is saved when a visitor comes to the page through URL that contains source parameter. Is stored for fifty years and is used for linking channels to conversions.
</remarks>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.TrackedCampaigns">
<summary>
Gets enumerable of campaigns which should be logged in web analytics service called by Javascript.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsHelper.Referrer">
<summary>
Replaceable referrer (checks "AnalyticsReferrerString" item in RequestStockHelper first).
</summary>
</member>
<member name="T:CMS.WebAnalytics.AnalyticsMethods">
<summary>
Methods for web analytics requiring the CMS context
</summary>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogVisitor(CMS.SiteProvider.SiteNameOnDemand)">
<summary>
Logs the site visitor.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogVisitor(System.String)">
<summary>
Logs the site visitor.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.SetVisitorStatusToContext(System.String,CMS.WebAnalytics.VisitorStatusEnum,System.Boolean)">
<summary>
Corrects visitor status value and saves it to context. <see cref="F:CMS.WebAnalytics.VisitorStatusEnum.MoreVisits"/> is set when visitors' idle time expired.
<see cref="F:CMS.WebAnalytics.VisitorStatusEnum.FirstVisit"/> is set in other scenarios.
</summary>
<param name="siteName">Name of current site</param>
<param name="visitorStatus">Visitor status</param>
<param name="idleExpired">True if last action of this visitor happened a long time ago so this visitor is returning to this site</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogMobileDevice(System.String)">
<summary>
Logs mobile device.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogConversion(CMS.SiteProvider.SiteNameOnDemand,System.String,System.String)">
<summary>
Logs conversion for given conversion name and value.
</summary>
<param name="siteName">Site name</param>
<param name="conversionName">Conversion name to track</param>
<param name="conversionValue">Conversion value</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogConversion(System.String,System.String,System.String)">
<summary>
Logs conversion for given conversion name and value.
</summary>
<param name="siteName">Site name</param>
<param name="conversionName">Conversion name to track</param>
<param name="conversionValue">Conversion value</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogSearchCrawler(System.String,CMS.PortalEngine.IPageInfo)">
<summary>
Logs search crawler visit for current page
</summary>
<param name="siteName">Site name</param>
<param name="currentPage">Current page info</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogAnalytics(System.String,CMS.PortalEngine.IPageInfo,System.String)">
<summary>
Logs statistics for landing and referring pages.
</summary>
<param name="sessionID">Current session ID</param>
<param name="currentPage">Current page info</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.AnalyticsMethods.LogPageNotFound(CMS.SiteProvider.SiteNameOnDemand)">
<summary>
Logs the page not found.
</summary>
<param name="siteName">Site name</param>
</member>
<member name="T:CMS.WebAnalytics.AnalyticsJSEventArgs">
<summary>
Arguments for event handlers related to logging analytics via JS.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsJSEventArgs.QueryParameters">
<summary>
Parameters to be passed via Ajax request when JavaScript logging is enabled.
</summary>
</member>
<member name="T:CMS.WebAnalytics.GenerateStatisticsEventArgs">
<summary>
Arguments for event handlers related to generating sample statistics data.
</summary>
</member>
<member name="P:CMS.WebAnalytics.GenerateStatisticsEventArgs.Date">
<summary>
Date for which the statistics should be generated.
</summary>
</member>
<member name="P:CMS.WebAnalytics.GenerateStatisticsEventArgs.Visitors">
<summary>
Contains number of visitor per every culture.
</summary>
</member>
<member name="T:CMS.WebAnalytics.GenerateStatisticsHandler">
<summary>
Handler for generating sample web analytics statistics.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GenerateStatisticsHandler.StartEvent(System.DateTime,System.Collections.Generic.IDictionary{System.String,System.Int32})">
<summary>
Initiates the event handling.
</summary>
<param name="date">Date for which the statistics should be generated</param>
<param name="visitors">Contains number of visitor per every culture</param>
</member>
<member name="T:CMS.WebAnalytics.InsertAnalyticsJSHandler">
<summary>
Handler for inserting web analytics javascript snippet to the page.
</summary>
</member>
<member name="M:CMS.WebAnalytics.InsertAnalyticsJSHandler.StartEvent(System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Initiates the event handling.
</summary>
<param name="queryParams">Query parameters to be sent via Ajax</param>
</member>
<member name="T:CMS.WebAnalytics.LogConversionHandler">
<summary>
Handler for the conversion logging.
</summary>
</member>
<member name="M:CMS.WebAnalytics.LogConversionHandler.StartEvent(CMS.WebAnalytics.LogRecord)">
<summary>
Initiates the event handling.
</summary>
<param name="conversion">Processed log record</param>
</member>
<member name="T:CMS.WebAnalytics.ProcessAnalyticsServiceHandler">
<summary>
Handler for the inserting javascript logging snippet to the page.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ProcessAnalyticsServiceHandler.StartEvent(System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Initiates the event handling.
</summary>
<param name="queryParams">Query parameters</param>
</member>
<member name="T:CMS.WebAnalytics.ExitPageInfo">
<summary>
ExitPageInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ExitPageInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.ExitPageInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfo.#ctor">
<summary>
Constructor - Creates an empty ExitPageInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new ExitPageInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.ExitPageInfo.SessionIdentificator">
<summary>
Session identificator.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ExitPageInfo.ExitPageNodeID">
<summary>
Exit page node ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ExitPageInfo.ExitPageLastModified">
<summary>
Exit page last modified.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ExitPageInfo.ExitPageSiteID">
<summary>
Exit page site ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ExitPageInfo.ExitPageCulture">
<summary>
Exit page culture.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ExitPageInfoProvider">
<summary>
Class providing ExitPageInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.GetExitPages">
<summary>
Returns a query for all the ExitPageInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.GetExitPageInfo(System.String)">
<summary>
Returns ExitPageInfo with specified session identificator.
</summary>
<param name="sessionIdentificator">Exit page session identificator.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.SetExitPageInfo(CMS.WebAnalytics.ExitPageInfo)">
<summary>
Sets (updates or inserts) specified ExitPageInfo.
</summary>
<param name="infoObj">ExitPageInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.DeleteExitPageInfo(CMS.WebAnalytics.ExitPageInfo)">
<summary>
Deletes specified ExitPageInfo.
</summary>
<param name="infoObj">ExitPageInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.DeleteExitPageInfo(System.String)">
<summary>
Deletes ExitPageInfo with specified name.
</summary>
<param name="name">ExitPageInfo name.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.GetExitPagesInternal">
<summary>
Returns a query for all the ExitPageInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.GetExitPageInfoInternal(System.String)">
<summary>
Returns ExitPageInfo with specified session identificator.
</summary>
<param name="sessionIdentificator">Exit page session identificator.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.SetExitPageInfoInternal(CMS.WebAnalytics.ExitPageInfo)">
<summary>
Sets (updates or inserts) specified ExitPageInfo.
</summary>
<param name="infoObj">ExitPageInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.ExitPageInfoProvider.DeleteExitPageInfoInternal(CMS.WebAnalytics.ExitPageInfo)">
<summary>
Deletes specified ExitPageInfo.
</summary>
<param name="infoObj">ExitPageInfo to be deleted.</param>
</member>
<member name="T:CMS.WebAnalytics.LogRecord">
<summary>
Representation of the one record (one row) from the analytics log file.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.LogTime">
<summary>
Time when the logged record occurred.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.CodeName">
<summary>
Code name of the log.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.Hits">
<summary>
Number of hits.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.Value">
<summary>
Total value.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.ValuesSet">
<summary>
List of hits values.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.ObjectName">
<summary>
Conversion name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.ObjectId">
<summary>
Object ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.SiteName">
<summary>
Site name where conversion occurred.
</summary>
</member>
<member name="P:CMS.WebAnalytics.LogRecord.Culture">
<summary>
Culture.
</summary>
</member>
<member name="T:CMS.WebAnalytics.LogExcludingFlags">
<summary>
Log excluding flags. Indicates which check actions should be skipped
</summary>
</member>
<member name="F:CMS.WebAnalytics.LogExcludingFlags.CheckAll">
<summary>
Check all
</summary>
</member>
<member name="F:CMS.WebAnalytics.LogExcludingFlags.SkipIpCheck">
<summary>
Skip IP address check
</summary>
</member>
<member name="F:CMS.WebAnalytics.LogExcludingFlags.SkipFileExtensionCheck">
<summary>
Skip file extension check
</summary>
</member>
<member name="F:CMS.WebAnalytics.LogExcludingFlags.SkipUrlCheck">
<summary>
Skip excluded URL check
</summary>
</member>
<member name="F:CMS.WebAnalytics.LogExcludingFlags.SkipCrawlerCheck">
<summary>
Skip Crawler check
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsFunctions">
<summary>
Web analytics marketing functions.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.IsReturningVisitor">
<summary>
Returns true if current visitor is returning.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.IsFirstTimeVisitor">
<summary>
Returns true if current visitor comes to the website for the first time.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.GetSearchEngineKeyword">
<summary>
Returns search keywords from search engine visitor came from.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.GetSearchEngine">
<summary>
Returns search engine visitor came from.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.GetUrlReferrer">
<summary>
Returns absolute URI of the URLRefferer from current HTTP context.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsFunctions.GetUrlReferrerParameter(System.String)">
<summary>
Returns value of specified URLReferrer query string parameter.
</summary>
<param name="parameterName">Query string parameter name</param>
</member>
<member name="T:CMS.WebAnalytics.VisitorMethods">
<summary>
Visitor methods - wrapping methods for macro resolver.
</summary>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.GetCurrentDistance(System.Object[])">
<summary>
Returns current distance (in kilometers) from specified location (based on Geo IP).
</summary>
<param name="parameters">
Latitude of the place;
Longitude of the place;
</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.IsReturningVisitor(System.Object[])">
<summary>
Returns true if current visitor is returning.
</summary>
<param name="parameters">Parameters</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.IsFirstTimeVisitor(System.Object[])">
<summary>
Returns true if current visitor comes to the website for the first time.
</summary>
<param name="parameters">Parameters</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.GetSearchEngineKeyword(System.Object[])">
<summary>
Returns search keywords from search engine visitor came from.
</summary>
<param name="parameters">Parameters</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.GetSearchEngine(System.Object[])">
<summary>
Returns search engine visitor came from.
</summary>
<param name="parameters">Parameters</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.GetUrlReferrer(System.Object[])">
<summary>
Returns absolute URI of the URLRefferer from current HTTP context.
</summary>
<param name="parameters">Parameters</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorMethods.GetUrlReferrerParameter(System.Object[])">
<summary>
Returns value of specified URLReferrer query string parameter.
</summary>
<param name="parameters">Query string parameter name</param>
</member>
<member name="T:CMS.WebAnalytics.CampaignInfo">
<summary>
CampaignInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.CampaignInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.GetCampaignStatus(System.DateTime)">
<summary>
Computes current campaign status for given <paramref name="dateTime"/>.
</summary>
<param name="dateTime">Date time to compute status to</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.#ctor">
<summary>
Constructor - Creates an empty CampaignInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new CampaignInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)">
<summary>
Overrides permission name for managing the object info.
</summary>
<param name="permission">Permission type</param>
<returns>ManageCampaigns permission name for managing permission type, or base permission name otherwise</returns>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignDisplayName">
<summary>
Campaign object display name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignID">
<summary>
Campaign object ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignSiteID">
<summary>
Campaign object site ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignDescription">
<summary>
Campaign object description.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignName">
<summary>
Campaign object name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignUTMCode">
<summary>
Campaign UTM code.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignOpenTo">
<summary>
Campaign open to.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignOpenFrom">
<summary>
Campaign open from.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignGUID">
<summary>
Campaign object unique identifier.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignLastModified">
<summary>
Campaign last modification date.
</summary>
</member>
<member name="P:CMS.WebAnalytics.CampaignInfo.CampaignEnabled">
<summary>
Indicates whether campaign is enabled.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CampaignInfoProvider">
<summary>
Class providing CampaignInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaigns">
<summary>
Returns a query for all the CampaignInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignInfo(System.Int32)">
<summary>
Returns campaign with specified ID.
</summary>
<param name="campaignId">Campaign ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignInfo(System.String,System.String)">
<summary>
Returns campaign with specified name.
</summary>
<param name="campaignName">Campaign name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.SetCampaignInfo(CMS.WebAnalytics.CampaignInfo)">
<summary>
Sets (updates or inserts) specified campaign.
</summary>
<param name="campaignObj">Campaign to be set</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.DeleteCampaignInfo(CMS.WebAnalytics.CampaignInfo)">
<summary>
Deletes specified campaign.
</summary>
<param name="campaignObj">Campaign to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.DeleteCampaignInfo(System.Int32)">
<summary>
Deletes campaign with specified ID.
</summary>
<param name="campaignId">Campaign ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.CampaignIsRunning(System.String,System.String)">
<summary>
Returns true if campaign is enabled and is valid for current date time.
</summary>
<param name="campaignName">Campaign name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.CampaignIsRunning(CMS.WebAnalytics.CampaignInfo)">
<summary>
Returns true if campaign is enabled and is valid for current date time.
</summary>
<param name="campaignInfo">Campaign info object</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.RenameCampaignStatistics(System.String,System.String,System.Int32)">
<summary>
Renames campaign statistics data when changed code name.
</summary>
<param name="oldName">Old code name</param>
<param name="newName">New code name</param>
<param name="siteID">Campaign site ID </param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignByUTMCode(System.String,System.String)">
<summary>
Returns campaign with given UTM code.
</summary>
<param name="utmCode">UTM code.</param>
<param name="siteName">Site name.</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignsInternal">
<summary>
Returns a query for all the CampaignInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignInfoInternal(System.Int32)">
<summary>
Returns campaign with specified ID.
</summary>
<param name="campaignId">Campaign ID</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignInfoInternal(System.String,System.String)">
<summary>
Returns campaign with specified name.
</summary>
<param name="campaignName">Campaign name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.SetCampaignInfoInternal(CMS.WebAnalytics.CampaignInfo)">
<summary>
Sets (updates or inserts) specified campaign.
</summary>
<param name="campaignObj">Campaign to be set</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.DeleteCampaignInfoInternal(CMS.WebAnalytics.CampaignInfo)">
<summary>
Deletes specified campaign.
</summary>
<param name="campaignObj">Campaign to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.CampaignIsRunningInternal(System.String,System.String)">
<summary>
Returns true if campaign is enabled and is valid for current date time.
</summary>
<param name="campaignName">Campaign name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.CampaignIsRunningInternal(CMS.WebAnalytics.CampaignInfo)">
<summary>
Returns true if campaign is enabled and is valid for current date time.
</summary>
<param name="campaignInfo">Campaign info object</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.RenameCampaignStatisticsInternal(System.String,System.String,System.Int32)">
<summary>
Renames campaign statistics data when changed code name.
</summary>
<param name="oldName">Old code name</param>
<param name="newName">New code name</param>
<param name="siteID">Campaign site ID </param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.GetCampaignByUTMCodeInternal(System.String,System.String)">
<summary>
Returns campaign with given UTM code.
</summary>
<param name="utmCode">UTM code.</param>
<param name="siteName">Site name.</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.RemoveAnalyticsData(CMS.WebAnalytics.CampaignInfo)">
<summary>
Removes analytics data.
</summary>
<param name="campaignObj">Campaign object</param>
</member>
<member name="M:CMS.WebAnalytics.CampaignInfoProvider.#ctor">
<summary>
Constructor using ID and codename Hashtables.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ConversionInfo">
<summary>
ConversionInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.ConversionInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.ConversionInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfo.#ctor">
<summary>
Constructor - Creates an empty ConversionInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new ConversionInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfo.GetPermissionName(CMS.DataEngine.PermissionsEnum)">
<summary>
Overrides permission name for managing the object info.
</summary>
<param name="permission">Permission type</param>
<returns>ManageConversions permission name for managing permission type, or base permission name otherwise</returns>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionGUID">
<summary>
Conversion object unique identifier.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionDescription">
<summary>
Conversion object description.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionID">
<summary>
Conversion object ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionSiteID">
<summary>
Conversion object site ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionLastModified">
<summary>
Date and time when the conversion object was last modified.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionName">
<summary>
Conversion object code name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.ConversionInfo.ConversionDisplayName">
<summary>
Conversion object display name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.ConversionInfoProvider">
<summary>
Class providing ConversionInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversions">
<summary>
Returns a query for all the ConversionInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversionInfo(System.Int32)">
<summary>
Returns conversion with specified ID.
</summary>
<param name="conversionId">Conversion ID</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversionInfo(System.String,System.String)">
<summary>
Returns conversion with specified name.
</summary>
<param name="conversionName">Conversion name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.SetConversionInfo(CMS.WebAnalytics.ConversionInfo)">
<summary>
Sets (updates or inserts) specified conversion.
</summary>
<param name="conversionObj">Conversion to be set</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.DeleteConversionInfo(CMS.WebAnalytics.ConversionInfo)">
<summary>
Deletes specified conversion.
</summary>
<param name="conversionObj">Conversion to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.DeleteConversionInfo(System.Int32)">
<summary>
Deletes conversion with specified ID.
</summary>
<param name="conversionId">Conversion ID</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.RenameConversionStatistics(System.String,System.String,System.Int32)">
<summary>
Renames conversion statistics data when changed code name
</summary>
<param name="oldName">Old code name</param>
<param name="newName">New code name</param>
<param name="siteID">Conversion site ID </param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversionsInternal">
<summary>
Returns a query for all the ConversionCampaignInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversionInfoInternal(System.Int32)">
<summary>
Returns conversion with specified ID.
</summary>
<param name="conversionId">Conversion ID</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.GetConversionInfoInternal(System.String,System.String)">
<summary>
Returns conversion with specified name.
</summary>
<param name="conversionName">Conversion name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.SetConversionInfoInternal(CMS.WebAnalytics.ConversionInfo)">
<summary>
Sets (updates or inserts) specified conversion.
</summary>
<param name="conversionObj">Conversion to be set</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.DeleteConversionInfoInternal(CMS.WebAnalytics.ConversionInfo)">
<summary>
Deletes specified conversion.
</summary>
<param name="conversionObj">Conversion to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.RemoveConversionFromDocuments(CMS.WebAnalytics.ConversionInfo)">
<summary>
Removes conversion from document nodes.
</summary>
<param name="conversionObj">Conversion object</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.RemoveAnalyticsData(CMS.WebAnalytics.ConversionInfo)">
<summary>
Removes analytics data.
</summary>
<param name="conversionObj">Conversion object</param>
</member>
<member name="M:CMS.WebAnalytics.ConversionInfoProvider.#ctor">
<summary>
Constructor using ID and codename Hashtables.
</summary>
</member>
<member name="T:CMS.WebAnalytics.PredefinedActivityType">
<summary>
Predefined activity types constants.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PAGE_VISIT">
<summary>
Code name for page visits activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.LANDING_PAGE">
<summary>
Code name for landing page activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.USER_LOGIN">
<summary>
Code name for user login activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.REGISTRATION">
<summary>
Code name for user registration activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.JOIN_GROUP">
<summary>
Code name for join group activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.LEAVE_GROUP">
<summary>
Code name for leave group activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PRODUCT_ADDED_TO_SHOPPINGCART">
<summary>
Code name for product added to shopping cart activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PRODUCT_REMOVED_FROM_SHOPPINGCART">
<summary>
Code name for product removed from shopping cart activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PRODUCT_ADDED_TO_WISHLIST">
<summary>
Code name for product added to wishlist activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PURCHASE">
<summary>
Code name for purchase activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.PURCHASEDPRODUCT">
<summary>
Code name for purchased product activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CUSTOMER_REGISTRATION">
<summary>
Code name for customer registration activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.NEWSLETTER_SUBSCRIBING">
<summary>
Code name for newsletter subscribing activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.NEWSLETTER_UNSUBSCRIBING">
<summary>
Code name for newsletter unsubscribing activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.NEWSLETTER_UNSUBSCRIBING_FROM_ALL">
<summary>
Code name for newsletter unsubscribing from all activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.NEWSLETTER_OPEN">
<summary>
Code name for newsletter open activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.NEWSLETTER_CLICKTHROUGH">
<summary>
Code name for newsletter clickthrough activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.EXTERNAL_SEARCH">
<summary>
Code name for external search activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.INTERNAL_SEARCH">
<summary>
Code name for internal search activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.BLOG_COMMENT">
<summary>
Code name for blog comment activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.FORUM_POST">
<summary>
Code name for forum post activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.MESSAGE_BOARD_COMMENT">
<summary>
Code name for message board comment activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.ABUSE_REPORT">
<summary>
Code name for abuse report activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.RATING">
<summary>
Code name for rating activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.EVENT_BOOKING">
<summary>
Code name for event booking activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.POLL_VOTING">
<summary>
Code name for poll voting activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.BIZFORM_SUBMIT">
<summary>
Code name for bizform submit activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.USER_CONTRIB_INSERT">
<summary>
Code name for insert user contribution activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.USER_CONTRIB_UPDATE">
<summary>
Code name for update user contribution activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.USER_CONTRIB_DELETE">
<summary>
Code name for delete user contribution activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.SUBSCRIPTION_MESSAGE_BOARD">
<summary>
Code name for message board subscription activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.SUBSCRIPTION_FORUM_POST">
<summary>
Code name for forum subscription activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.SUBSCRIPTION_BLOG_POST">
<summary>
Code name for blog post subscription activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CHAT_REQUEST_SUPPORT">
<summary>
Code name for requesting support using chat.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CHAT_REQUEST_SUPPORT_OFFLINE_FORM">
<summary>
Code name for requesting support using offline support form (when there are no online supporters on chat).
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CHAT_ACCEPT_INITIATED_CHAT">
<summary>
Code name for accepting initiated chat request.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CHAT_ACCEPT_AUTOMATICALLY_INITIATED_CHAT">
<summary>
Code name for accepting initiated chat request which was issued automatically (using Automatically initiated chat request).
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CUSTOM_ACTIVITY">
<summary>
Code name for custom activity activity.
</summary>
</member>
<member name="F:CMS.WebAnalytics.PredefinedActivityType.CUSTOM_TABLE_SUBMIT">
<summary>
Code name for custom table form submit activity.
</summary>
</member>
<member name="T:CMS.WebAnalytics.AnalyticsContext">
<summary>
Analytics context.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.ActivityEnvironmentVariables">
<summary>
Activity variables used for initialization.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.CurrentGeoLocation">
<summary>
Current GEO location
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.RequestContactID">
<summary>
Returns current contact ID retrieved during request.
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.CurrentVisitStatus">
<summary>
Gets or sets the current visit status
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.IsReturningVisitor">
<summary>
Returns true if the visitor is returning
</summary>
</member>
<member name="P:CMS.WebAnalytics.AnalyticsContext.IsNewVisitor">
<summary>
Returns true, if the visitor is a new visitor
</summary>
</member>
<member name="T:CMS.WebAnalytics.GeoLocation">
<summary>
Class representing location of specific IP.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.#ctor">
<summary>
Empty constructor.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.#ctor(System.Double,System.Double)">
<summary>
Basic constructor.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.#ctor(System.String,System.String,System.String,System.String,System.String,System.Double,System.Double,System.Int32,System.String,System.Int32,System.Int32)">
<summary>
Public constructor.
</summary>
<param name="coutryCode">Country code</param>
<param name="countryName">Country name</param>
<param name="regionCode">Region/state code</param>
<param name="regionName">Region/state name</param>
<param name="city">City name</param>
<param name="latitude">Latitude</param>
<param name="longitude">Longitude</param>
<param name="areaCode">Area code</param>
<param name="postalCode">Postal code</param>
<param name="dmaCode">DMA code</param>
<param name="metroCode">Metro code</param>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.#ctor(MaxMindGeoIP.Location)">
<summary>
Constructor initialized by MaxMind location object.
</summary>
<param name="location">Location object</param>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.Distance(System.Double,System.Double)">
<summary>
Returns distance in kilometers between current location and location specified by coordinates.
</summary>
<param name="latitude">Latitude</param>
<param name="longitude">Longitude</param>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.RegisterColumns">
<summary>
Registers columns of the GeoLocation object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoLocation.GetCountry(CMS.WebAnalytics.GeoLocation)">
<summary>
Returns the country info object.
</summary>
<param name="location">GeoLocation object to get the data (CountryCode) from</param>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.CountryCode">
<summary>
Country code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.CountryName">
<summary>
Country name
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.StateCode">
<summary>
State code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.StateName">
<summary>
State name
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.State">
<summary>
State object
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.RegionCode">
<summary>
Region/state code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.RegionName">
<summary>
Region/state name
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.City">
<summary>
City name
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.Latitude">
<summary>
Latitude
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.Longitude">
<summary>
Longitude
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.AreaCode">
<summary>
Area code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.PostalCode">
<summary>
Postal code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.DMACode">
<summary>
DMA code
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoLocation.MetroCode">
<summary>
Metro code
</summary>
</member>
<member name="T:CMS.WebAnalytics.GeoIPHelper">
<summary>
Provides IP address to GEO location conversion.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCurrentGeoLocation">
<summary>
Returns geo location according to current IP (RequestContext.UserHostAddress).
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCountryByIp(System.String)">
<summary>
Finds country name by IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
<returns>Country name</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCountryIDByIp(System.String)">
<summary>
Finds ID of country from CMS_Country table by IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
<returns>ID of country from CMS_Country table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetStateByIp(System.String)">
<summary>
Finds state code name by IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
<returns>State code name compatible with states in CMS_State table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetStateIDByIp(System.String)">
<summary>
Finds ID of state from CMS_State table by IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
<returns>ID of state from CMS_State table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetLocationByIp(System.String)">
<summary>
Returns location object according to IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetOrganizationByIp(System.String)">
<summary>
Finds organization/company name by IP4 address.
</summary>
<param name="dottedQuadIp">IP4 address</param>
<returns>Organization/company name</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.InitIPToLocationService(System.Int32)">
<summary>
Initializes the IP to location service with options.
</summary>
<param name="options">The options from LookupService. Like GEOIP_STANDARD, GEOIP_MEMORY_CACHE, etc.</param>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.InitIPToOrgService(System.Int32)">
<summary>
Initializes the IP to organization service with options.
</summary>
<param name="options">The options from LookupService. Like GEOIP_STANDARD, GEOIP_MEMORY_CACHE, etc.</param>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.ClearLookUpServices">
<summary>
Clears MaxMind GeoIP lookup services.
</summary>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCountryByIpInternal(System.String)">
<summary>
Finds country name by IP4 address.
</summary>
<param name="ip">IP4 address</param>
<returns>Country name</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCountryIDByIpInternal(System.String)">
<summary>
Finds ID of country from CMS_Country table by IP4 address.
</summary>
<param name="ip">IP4 address</param>
<returns>ID of country from CMS_Country table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetStateByIpInternal(System.String)">
<summary>
Finds state code name by IP4 address.
</summary>
<param name="ip">IP4 address</param>
<returns>State code name compatible with states in CMS_State table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetStateIDByIpInternal(System.String)">
<summary>
Finds ID of state from CMS_State table by IP4 address.
</summary>
<param name="ip">IP4 address</param>
<returns>ID of state from CMS_State table</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetLocationByIpInternal(System.String)">
<summary>
Returns location object according to IP4 address.
</summary>
<param name="ip">IP4 address</param>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetOrganizationByIpInternal(System.String)">
<summary>
Finds organization/company name by IP4 address.
</summary>
<param name="ip">IP4 address</param>
<returns>Organization/company name</returns>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetCMSCountryIDByCountryCode(System.String)">
<summary>
Returns ID of CMS country specified by country code.
</summary>
<param name="code">Country code</param>
</member>
<member name="M:CMS.WebAnalytics.GeoIPHelper.GetLocation(System.String)">
<summary>
Gets location object.
</summary>
<param name="dottedQuadIp">IP4 address</param>
</member>
<member name="P:CMS.WebAnalytics.GeoIPHelper.LocationServiceFileName">
<summary>
Returns name of LocationService file.
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoIPHelper.LocationServiceFilePath">
<summary>
Returns physical file path to LocationService file.
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoIPHelper.OrgServiceFilePath">
<summary>
Returns physical file path to OrgService file.
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoIPHelper.IPToLocationService">
<summary>
Gets lookup service for country, region, city, ...
</summary>
</member>
<member name="P:CMS.WebAnalytics.GeoIPHelper.IPToOrgService">
<summary>
Gets lookup service for organization
</summary>
</member>
<member name="T:CMS.WebAnalytics.ProcessLogRecordHandler">
<summary>
Handler for the log processing.
</summary>
</member>
<member name="M:CMS.WebAnalytics.ProcessLogRecordHandler.StartEvent(CMS.WebAnalytics.LogRecord)">
<summary>
Initiates the event handling.
</summary>
<param name="logRecord">Processed log record</param>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsEvents">
<summary>
Web analytics events.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.ProcessLogRecord">
<summary>
Fires when analytics log is being processed.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.LogConversion">
<summary>
Fires when conversion is logged.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.ProcessAnalyticsService">
<summary>
Fires when analytics are being logged in WebAnalyticsService.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.InsertAnalyticsJS">
<summary>
Fires when web analytics JavaScript snippet is being inserted to the page.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.GenerateStatistics">
<summary>
Fires when web analytics statistics are being generated.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignLaunched">
<summary>
Fires when campaign is being launched.
</summary>
<remarks>
When attaching to this handler please consider also attach to the <see cref="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignLaunchLog"/>.
<see cref="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignLaunchLog"/> only explains what will happen to the campaign after real launch.
</remarks>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignLaunchLog">
<summary>
Fires when campaign launch collects messages of all actions.
</summary>
<remarks>
Do not modify any the content or do not make any persistent changes (these changes should be handled in <see cref="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignLaunched"/>).
Event should only insert messages to the <see cref="P:CMS.WebAnalytics.CampaignLaunchLogEventArgs.Messages"/> which explains what will happen to the campaign after launch.
</remarks>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsEvents.CampaignUTMChanged">
<summary>
Fires when there is a change in campaigns UTM parameter.
</summary>
</member>
<member name="T:CMS.WebAnalytics.CurrentUserFields">
<summary>
Wrapper class to provide fields from System.Math namespace in the MacroEngine.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CurrentUserFields.RegisterFields">
<summary>
Registers the math fields.
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsHandlers">
<summary>
Web analytics events handlers
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsHandlers.PARAM_PAGE_GUID">
<summary>
Page GUID query parameter name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsHandlers.PARAM_PAGE_SITE_ID">
<summary>
Page site ID query parameter name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsHandlers.CAMPAIGN_URL_TRACKING_PARAMETER">
<summary>
Query parameter name for the campaign tracking.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsHandlers.SOURCE_URL_TRACKING_PARAMETER">
<summary>
Query parameter name for the source tracking.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.Init">
<summary>
Initializes the events handlers.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogCampaignConversions(System.Object,CMS.Base.CMSEventArgs{CMS.WebAnalytics.LogRecord})">
<summary>
Log conversion for campaign.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogUTMParameters(System.Object,CMS.Base.CMSEventArgs{CMS.WebAnalytics.LogRecord})">
<summary>
Log UTM parameters for given campaign.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.IsDocumentPartOfCampaign(CMS.WebAnalytics.CampaignInfo,System.Guid)">
<summary>
Determines whether the given <paramref name="documentGuid"/> is asset of the given <paramref name="campaign"/>.
</summary>
<param name="campaign">Instance of <see cref="T:CMS.WebAnalytics.CampaignInfo"/> to be determined</param>
<param name="documentGuid"><see cref="T:System.Guid"/> of the document to be checked</param>
<returns>True, if given <paramref name="documentGuid"/> is asset of the <paramref name="campaign"/>; otherwise, false</returns>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.HandleEndAnalytics(System.Object,System.EventArgs)">
<summary>
Logs the necessary analytics at the end of the current request
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogEndAnalytics">
<summary>
Logs analytics at the end of the request
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogEndActivities">
<summary>
Logs activities at the end of the request
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogBeginAnalytics">
<summary>
Logs web analytics within the request
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogBeginActivities(System.String)">
<summary>
Logs activities for current request
</summary>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogCampaignsViaJavascript(System.Object,CMS.WebAnalytics.AnalyticsJSEventArgs)">
<summary>
Logs all campaigns located in TrackedCampaign cookie. This is needed when campaigns should be logged asynchronously in the web service - in that
case <see cref="M:CMS.WebAnalytics.CampaignService.SetCampaign(System.String,System.String,System.String)"/> only stores campaign name in the cookies and this method logs it.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.DelayEndOfTheRequest(System.Object,CMS.OutputFilter.OutputCacheEventArgs)">
<summary>
Delays the end of the request when full page caching if Analytics or Activities are enabled.
Fired when cache successfully loaded.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogCampaign(System.Object,System.EventArgs)">
<summary>
Logs campaign.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsHandlers.LogPageViewConversion(System.Object,System.EventArgs)">
<summary>
Logs page view conversion. Requires access to the Session object.
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsModuleMetadata">
<summary>
Represents the Web Analytics module metadata.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModuleMetadata.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsResolvers">
<summary>
Resolvers used in e-mail templates and other macro visual components.
</summary>
</member>
<member name="P:CMS.WebAnalytics.WebAnalyticsResolvers.AnalyticsResolver">
<summary>
Returns web analytics resolver.
</summary>
</member>
<member name="T:CMS.WebAnalytics.RemoveAnalyticsData">
<summary>
RemoveAnalyticsData class.
</summary>
</member>
<member name="M:CMS.WebAnalytics.RemoveAnalyticsData.Execute(CMS.Scheduler.TaskInfo)">
<summary>
Executes the remove analytics task.
</summary>
<param name="task">Task to process</param>
</member>
<member name="T:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer">
<summary>
Compares user-agent with ones that use crawlers from defined search engines.
</summary>
</member>
<member name="F:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer.cacheDependency">
<summary>
Cached cache settings.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer.GetCachedCrawlerItems">
<summary>
Gets all crawler names associated with search engine IDs.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer.GetCrawlerItems">
<summary>
Gets all crawler names associated with search engine IDs.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer.GetSearchEngineFromUserAgent(System.String)">
<summary>
Returns <see cref="T:CMS.WebAnalytics.SearchEngineInfo"/> for crawlers identified by user agent.
</summary>
<param name="userAgent">User agent string that might contain crawler identifier</param>
<returns><see cref="T:CMS.WebAnalytics.SearchEngineInfo"/> of search engine that has given crawler or null if no search engine matches</returns>
</member>
<member name="T:CMS.WebAnalytics.SearchEngineCrawlerAnalyzer.CrawlerCachedItem">
<summary>
Struct for expressing cached crawler name with search engine ID.
</summary>
</member>
<member name="T:CMS.WebAnalytics.SearchEngineAnalyzer">
<summary>
Analyzes whether URLs come from some of the defined search engines and gets the search keywords from them.
Use it on referrer URL to get where the visitor came from.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineAnalyzer.GetCachedSearchEngineDomains">
<summary>
Gets cached search engine domains with corresponding search engine IDs.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineAnalyzer.GetSearchEngineDomains">
<summary>
Gets search engine domains with corresponding search engine IDs.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineAnalyzer.GetSearchEngineFromUrl(System.String,System.String@)">
<summary>
Returns search engine name for specified URL.
</summary>
<param name="url">Absolute URL that can contain search keywords</param>
<param name="searchKeyword">Search keyword that's in the URL</param>
<returns><see cref="T:CMS.WebAnalytics.SearchEngineInfo"/> of search engine that corresponds to <paramref name="url"/>. Returns null if no search engine matches.</returns>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineAnalyzer.StripProtocolAndWww(System.String)">
<summary>
Gets the URL for matching the search engine domain rule. Removes protocol and www. from the URL.
E.g. converts "http://www.google.com/abc?def" to "google.com/abc?def".
</summary>
<param name="url">URL to process</param>
</member>
<member name="T:CMS.WebAnalytics.SearchEngineInfo">
<summary>
SearchEngineInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.SearchEngineInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.SearchEngineInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfo.#ctor">
<summary>
Constructor - Creates an empty SearchEngineInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new SearchEngineInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data</param>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineKeywordParameter">
<summary>
Search engine object keyword parameter.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineLastModified">
<summary>
Date of last modification of search engine object.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineDomainRule">
<summary>
Search engine object domain role.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineDisplayName">
<summary>
Search engine object display name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineName">
<summary>
Search engine object code name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineID">
<summary>
Search engine object ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineGUID">
<summary>
Search engine object GUID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.SearchEngineInfo.SearchEngineCrawler">
<summary>
Search engine crawler.
</summary>
</member>
<member name="T:CMS.WebAnalytics.SearchEngineInfoProvider">
<summary>
Class providing SearchEngineInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEngines">
<summary>
Returns a query for all the SearchEngineInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEngineInfo(System.Int32)">
<summary>
Returns search engine with specified ID.
</summary>
<param name="engineId">Search engine ID</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEngineInfo(System.String)">
<summary>
Returns search engine with specified name.
</summary>
<param name="engineName">Search engine name</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.SetSearchEngineInfo(CMS.WebAnalytics.SearchEngineInfo)">
<summary>
Sets (updates or inserts) specified search engine.
</summary>
<param name="engineObj">Search engine to be set</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.DeleteSearchEngineInfo(CMS.WebAnalytics.SearchEngineInfo)">
<summary>
Deletes specified search engine.
</summary>
<param name="engineObj">Search engine to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.DeleteSearchEngineInfo(System.Int32)">
<summary>
Deletes search engine with specified ID.
</summary>
<param name="engineId">Search engine ID</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.Clear(System.Boolean)">
<summary>
Clears hashtables.
</summary>
<param name="logTasks">If true, web farm tasks are logged</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEnginesInternal">
<summary>
Returns a query for all the SearchEngineInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEngineInfoInternal(System.Int32)">
<summary>
Returns search engine with specified ID.
</summary>
<param name="engineId">Search engine ID</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.GetSearchEngineInfoInternal(System.String)">
<summary>
Returns search engine with specified name.
</summary>
<param name="engineName">Search engine name</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.SetSearchEngineInfoInternal(CMS.WebAnalytics.SearchEngineInfo)">
<summary>
Sets (updates or inserts) specified search engine.
</summary>
<param name="engineObj">Search engine to be set</param>
</member>
<member name="M:CMS.WebAnalytics.SearchEngineInfoProvider.DeleteSearchEngineInfoInternal(CMS.WebAnalytics.SearchEngineInfo)">
<summary>
Deletes specified search engine.
</summary>
<param name="engineObj">Search engine to be deleted</param>
</member>
<member name="T:CMS.WebAnalytics.HitsDayInfo">
<summary>
HitsDayInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsDayInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsDayInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfo.#ctor">
<summary>
Constructor - Creates an empty HitsDayInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new HitsDayInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsDayInfo.HitsValue">
<summary>
Hits value.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsDayInfoProvider">
<summary>
Class providing HitsDayInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetHitsDays">
<summary>
Returns a query for all the HitsDayInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetHitsDayInfo(System.Int32)">
<summary>
Returns HitsDayInfo with specified ID.
</summary>
<param name="id">HitsDayInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.SetHitsDayInfo(CMS.WebAnalytics.HitsDayInfo)">
<summary>
Sets (updates or inserts) specified HitsDayInfo.
</summary>
<param name="infoObj">HitsDayInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.DeleteHitsDayInfo(CMS.WebAnalytics.HitsDayInfo)">
<summary>
Deletes specified HitsDayInfo.
</summary>
<param name="infoObj">HitsDayInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.DeleteHitsDayInfo(System.Int32)">
<summary>
Deletes HitsDayInfo with specified ID.
</summary>
<param name="id">HitsDayInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetStatisticsBoundaries(System.String)">
<summary>
Returns max (DateTo) a min (DateFrom) datetime for given statistics.
</summary>
<param name="where">Where condition (contains statisticscode for query)</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetHitsDaysInternal">
<summary>
Returns a query for all the HitsDayInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetHitsDayInfoInternal(System.Int32)">
<summary>
Returns HitsDayInfo with specified ID.
</summary>
<param name="id">HitsDayInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.SetHitsDayInfoInternal(CMS.WebAnalytics.HitsDayInfo)">
<summary>
Sets (updates or inserts) specified HitsDayInfo.
</summary>
<param name="infoObj">HitsDayInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.DeleteHitsDayInfoInternal(CMS.WebAnalytics.HitsDayInfo)">
<summary>
Deletes specified HitsDayInfo.
</summary>
<param name="infoObj">HitsDayInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsDayInfoProvider.GetStatisticsBoundariesInternal(System.String)">
<summary>
Returns max (DateTo) a min (DateFrom) datetime for given statistics.
</summary>
<param name="where">Where condition (contains statisticscode for query)</param>
</member>
<member name="T:CMS.WebAnalytics.HitsHourInfo">
<summary>
HitsHourInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsHourInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsHourInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfo.#ctor">
<summary>
Constructor - Creates an empty HitsHourInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new HitsHourInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsHourInfo.HitsValue">
<summary>
Hits value.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsHourInfoProvider">
<summary>
Class providing HitsHourInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.GetHitsHours">
<summary>
Returns a query for all the HitsHourInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.GetHitsHourInfo(System.Int32)">
<summary>
Returns HitsHourInfo with specified ID.
</summary>
<param name="id">HitsHourInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.SetHitsHourInfo(CMS.WebAnalytics.HitsHourInfo)">
<summary>
Sets (updates or inserts) specified HitsHourInfo.
</summary>
<param name="infoObj">HitsHourInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.DeleteHitsHourInfo(CMS.WebAnalytics.HitsHourInfo)">
<summary>
Deletes specified HitsHourInfo.
</summary>
<param name="infoObj">HitsHourInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.DeleteHitsHourInfo(System.Int32)">
<summary>
Deletes HitsHourInfo with specified ID.
</summary>
<param name="id">HitsHourInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.GetHitsHoursInternal">
<summary>
Returns a query for all the HitsHourInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.GetHitsHourInfoInternal(System.Int32)">
<summary>
Returns HitsHourInfo with specified ID.
</summary>
<param name="id">HitsHourInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.SetHitsHourInfoInternal(CMS.WebAnalytics.HitsHourInfo)">
<summary>
Sets (updates or inserts) specified HitsHourInfo.
</summary>
<param name="infoObj">HitsHourInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsHourInfoProvider.DeleteHitsHourInfoInternal(CMS.WebAnalytics.HitsHourInfo)">
<summary>
Deletes specified HitsHourInfo.
</summary>
<param name="infoObj">HitsHourInfo to be deleted.</param>
</member>
<member name="T:CMS.WebAnalytics.HitsMonthInfo">
<summary>
HitsMonthInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsMonthInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsMonthInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfo.#ctor">
<summary>
Constructor - Creates an empty HitsMonthInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new HitsMonthInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsMonthInfo.HitsValue">
<summary>
Hits value.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsMonthInfoProvider">
<summary>
Class providing HitsMonthInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.GetHitsMonths">
<summary>
Returns a query for all the HitsMonthInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.GetHitsMonthInfo(System.Int32)">
<summary>
Returns HitsMonthInfo with specified ID.
</summary>
<param name="id">HitsMonthInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.SetHitsMonthInfo(CMS.WebAnalytics.HitsMonthInfo)">
<summary>
Sets (updates or inserts) specified HitsMonthInfo.
</summary>
<param name="infoObj">HitsMonthInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.DeleteHitsMonthInfo(CMS.WebAnalytics.HitsMonthInfo)">
<summary>
Deletes specified HitsMonthInfo.
</summary>
<param name="infoObj">HitsMonthInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.DeleteHitsMonthInfo(System.Int32)">
<summary>
Deletes HitsMonthInfo with specified ID.
</summary>
<param name="id">HitsMonthInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.GetHitsMonthsInternal">
<summary>
Returns a query for all the HitsMonthInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.GetHitsMonthInfoInternal(System.Int32)">
<summary>
Returns HitsMonthInfo with specified ID.
</summary>
<param name="id">HitsMonthInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.SetHitsMonthInfoInternal(CMS.WebAnalytics.HitsMonthInfo)">
<summary>
Sets (updates or inserts) specified HitsMonthInfo.
</summary>
<param name="infoObj">HitsMonthInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsMonthInfoProvider.DeleteHitsMonthInfoInternal(CMS.WebAnalytics.HitsMonthInfo)">
<summary>
Deletes specified HitsMonthInfo.
</summary>
<param name="infoObj">HitsMonthInfo to be deleted.</param>
</member>
<member name="T:CMS.WebAnalytics.HitsWeekInfo">
<summary>
HitsWeekInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsWeekInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsWeekInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfo.#ctor">
<summary>
Constructor - Creates an empty HitsWeekInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new HitsWeekInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsWeekInfo.HitsValue">
<summary>
Hits value.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsWeekInfoProvider">
<summary>
Class providing HitsWeekInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.GetHitsWeeks">
<summary>
Returns a query for all the HitsWeekInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.GetHitsWeekInfo(System.Int32)">
<summary>
Returns HitsWeekInfo with specified ID.
</summary>
<param name="id">HitsWeekInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.SetHitsWeekInfo(CMS.WebAnalytics.HitsWeekInfo)">
<summary>
Sets (updates or inserts) specified HitsWeekInfo.
</summary>
<param name="infoObj">HitsWeekInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.DeleteHitsWeekInfo(CMS.WebAnalytics.HitsWeekInfo)">
<summary>
Deletes specified HitsWeekInfo.
</summary>
<param name="infoObj">HitsWeekInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.DeleteHitsWeekInfo(System.Int32)">
<summary>
Deletes HitsWeekInfo with specified ID.
</summary>
<param name="id">HitsWeekInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.GetHitsWeeksInternal">
<summary>
Returns a query for all the HitsWeekInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.GetHitsWeekInfoInternal(System.Int32)">
<summary>
Returns HitsWeekInfo with specified ID.
</summary>
<param name="id">HitsWeekInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.SetHitsWeekInfoInternal(CMS.WebAnalytics.HitsWeekInfo)">
<summary>
Sets (updates or inserts) specified HitsWeekInfo.
</summary>
<param name="infoObj">HitsWeekInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsWeekInfoProvider.DeleteHitsWeekInfoInternal(CMS.WebAnalytics.HitsWeekInfo)">
<summary>
Deletes specified HitsWeekInfo.
</summary>
<param name="infoObj">HitsWeekInfo to be deleted.</param>
</member>
<member name="T:CMS.WebAnalytics.HitsYearInfo">
<summary>
HitsYearInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsYearInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsYearInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfo.#ctor">
<summary>
Constructor - Creates an empty HitsYearInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new HitsYearInfo object from the given DataRow.
</summary>
<param name="dr">DataRow with the object data.</param>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsYearInfo.HitsValue">
<summary>
Hits value.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsYearInfoProvider">
<summary>
Class providing HitsYearInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.GetHitsYears">
<summary>
Returns a query for all the HitsYearInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.GetHitsYearInfo(System.Int32)">
<summary>
Returns HitsYearInfo with specified ID.
</summary>
<param name="id">HitsYearInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.SetHitsYearInfo(CMS.WebAnalytics.HitsYearInfo)">
<summary>
Sets (updates or inserts) specified HitsYearInfo.
</summary>
<param name="infoObj">HitsYearInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.DeleteHitsYearInfo(CMS.WebAnalytics.HitsYearInfo)">
<summary>
Deletes specified HitsYearInfo.
</summary>
<param name="infoObj">HitsYearInfo to be deleted.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.DeleteHitsYearInfo(System.Int32)">
<summary>
Deletes HitsYearInfo with specified ID.
</summary>
<param name="id">HitsYearInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.GetHitsYearsInternal">
<summary>
Returns a query for all the HitsYearInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.GetHitsYearInfoInternal(System.Int32)">
<summary>
Returns HitsYearInfo with specified ID.
</summary>
<param name="id">HitsYearInfo ID.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.SetHitsYearInfoInternal(CMS.WebAnalytics.HitsYearInfo)">
<summary>
Sets (updates or inserts) specified HitsYearInfo.
</summary>
<param name="infoObj">HitsYearInfo to be set.</param>
</member>
<member name="M:CMS.WebAnalytics.HitsYearInfoProvider.DeleteHitsYearInfoInternal(CMS.WebAnalytics.HitsYearInfo)">
<summary>
Deletes specified HitsYearInfo.
</summary>
<param name="infoObj">HitsYearInfo to be deleted.</param>
</member>
<member name="T:CMS.WebAnalytics.CampaignAssetModelService">
<summary>
Service that provides method to work with the <see cref="T:CMS.WebAnalytics.CampaignAssetViewModel"/> objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.CampaignAssetModelService.GetStrategy(System.String)">
<summary>
Returns specific campaign asset model service strategy.
</summary>
<param name="type">Type of asset to work with.</param>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsService">
<summary>
Web analytics can be tracked in 2 ways. The first is to track web analytics right on each request, the second is to log web analytics with a WebService
that is called by AJAX call from a client. The latter method makes web analytics more precise, because it doesn't log web crawlers, RSS readers and other
non-human traffic that can't execute JavaScript code. That's why this method is default.
The JavaScript call is added to a page on <see cref="E:CMS.Helpers.PageContext.PreRender"/> event, see <see cref="T:CMS.WebAnalytics.WebAnalyticsHandlers"/> for more.
</summary>
<exclude/>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.#ctor">
<summary>
Constructor. Adds header telling the crawlers not to index this service page.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.LogSearch(System.String,System.String,System.String)">
<summary>
Method for logging on-site search keywords. Ajax call that calls this method is called in SearchResults WebPart.
</summary>
<param name="keyword">A keyword that has been searched</param>
<param name="nodeAliasPath">A NodeAliasPath of a page on which is processed the AJAX call</param>
<param name="cultureCode">A culture of a page on which is processed the AJAX call</param>
<returns>"ok" string if everything went ok</returns>
<exception cref="T:System.InvalidOperationException">Logging by JS is not enabled</exception>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.LogBannerHit(System.String)">
<summary>
Method for logging banner hit (=banner view). Ajax call that calls this method is called in BannerRotator WebPart.
</summary>
<param name="bannerID">ID of a banner that's being viewed</param>
<returns>"ok" string if everything went ok</returns>
<exception cref="T:System.InvalidOperationException">Logging by JS is not enabled</exception>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.LogHits(System.Object)">
<summary>
Method for logging most of web analytics (page view, browser type, countries, ..). See code comments for more details. Web analytics that doesn't make sense
to log via JavaScript (RSS crawlers, 404s, ..) are omitted.
</summary>
<param name="parameters">
Dictionary of all parameters that go to the web service. This is different than in other web service methods, because you can modify
items that are being sent to the web service with <see cref="F:CMS.WebAnalytics.WebAnalyticsEvents.InsertAnalyticsJS"/> event and than process those parameters
with <see cref="F:CMS.WebAnalytics.WebAnalyticsEvents.ProcessAnalyticsService"/> event.
<see cref="T:System.Object"/> is used because IDictionary cannot be serialized to XML, thus Get request to WebAnalyticsService.asmx always threw exception.
</param>
<returns>"ok" string if everything went ok; null or exception message otherwise</returns>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.CreateStringDictionary(System.Object)">
<summary>
Method that converts Object to Dictionary{String, String}.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.GetLogHitsParams(System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Checks if all required parameters are present and extracts typed representation of the parameters for the LogHits method.
</summary>
<param name="parameters">Plain representation of the parameters</param>
<returns>Typed representation of the LogHits parameters</returns>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsService.GetErrorMessage(System.Exception)">
<summary>
Creates error message suitable for sending back to client.
</summary>
<param name="e">Exception which caused error</param>
<returns>Message for client</returns>
</member>
<member name="T:CMS.WebAnalytics.VisitorStatusCode">
<summary>
Visitor status code.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.Unknown">
<summary>
Unknown status.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.UnknownString">
<summary>
Unknown status as string.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.FirstVisit">
<summary>
First user visit.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.FirstVisitString">
<summary>
First user visit as string.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.MoreVisits">
<summary>
More user visits.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusCode.MoreVisitsString">
<summary>
More user visits as string.
</summary>
</member>
<member name="M:CMS.WebAnalytics.VisitorStatusCode.ToEnum(System.Int32)">
<summary>
Returns the enumeration representation of the Visitor status.
</summary>
<param name="code">Status code</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorStatusCode.FromEnum(CMS.WebAnalytics.VisitorStatusEnum)">
<summary>
Returns the visitor status code from the enumeration value.
</summary>
<param name="value">Value to convert</param>
</member>
<member name="M:CMS.WebAnalytics.VisitorStatusCode.FromEnumString(CMS.WebAnalytics.VisitorStatusEnum)">
<summary>
Returns the visitor status code from the enumeration value.
</summary>
<param name="value">Value to convert</param>
</member>
<member name="T:CMS.WebAnalytics.VisitorStatusEnum">
<summary>
Visitor status.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusEnum.Unknown">
<summary>
Unknown status.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusEnum.FirstVisit">
<summary>
First visit of the web site.
</summary>
</member>
<member name="F:CMS.WebAnalytics.VisitorStatusEnum.MoreVisits">
<summary>
More visits.
</summary>
</member>
<member name="T:CMS.WebAnalytics.UserPage">
<summary>
Class providing information about last visited page.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UserPage.TimeStamp">
<summary>
Last request timestamp.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UserPage.LastPageNodeAliasPath">
<summary>
Gets or sets the last page node alias path.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UserPage.LastPageNodeID">
<summary>
Gets or sets the last page node ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UserPage.LastPageCulture">
<summary>
Gets or sets the last page culture.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UserPage.LastPageSiteName">
<summary>
Gets or sets the last page site name.
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsModule">
<summary>
Represents the Web Analytics module.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsModule.ONLINEMARKETING">
<summary>
Online marketing group constant
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsModule.WEBANALYTICS">
<summary>
Web analytics group constant
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.OnPreInit">
<summary>
Pre-initializes the module.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.OnInit">
<summary>
Initializes the module.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.InitMacros">
<summary>
Initializes the web analytics macros
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.RegisterCommands">
<summary>
Registers the object type of this module
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsModule.LogOnSiteKeyWords(System.Object[])">
<summary>
Log on-site key words
</summary>
<param name="parameters">Parameters array</param>
</member>
<member name="T:CMS.WebAnalytics.HitLogProcessor">
<summary>
HitLogProcessor class.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.Execute(CMS.Scheduler.TaskInfo)">
<summary>
Executes the logprocessor action.
</summary>
<param name="task">Task to process</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ProcessExitPages">
<summary>
Creates log. files for expired exit page candidates and removes exit pages records.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ProcessFinishedLogs">
<summary>
Gets the log files that are finished (are no longer valid).
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ProcessLog(System.String)">
<summary>
Processes the whole log file in memory and writes the results to the database.
</summary>
<param name="fileName">Log file name</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ProcessLog(System.String,System.String)">
<summary>
Processes the whole log file in memory and writes the results to the database.
</summary>
<param name="fileName">Log file name</param>
<param name="codeName">Statistics code name</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ProcessLogRecord(CMS.WebAnalytics.LogRecord)">
<summary>
Processes the log record to DB.
</summary>
<param name="logRecord">Log record data</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.HandleCampaignConversion(System.String,System.String,System.String)">
<summary>
Checks if processed log is campaign conversion and saves it.
</summary>
<param name="codeName">Log code name.</param>
<param name="objectName">Object name.</param>
<param name="siteName">Site name.</param>
<returns>Returns false if processing shall be stopped because this log is comaign conversion but is not valid. Log should continue to be processed if true is returned.</returns>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.SaveLogToDatabase(CMS.WebAnalytics.LogRecord)">
<summary>
Splits log into time intervals (days, hours, etc.) and saves it to the database.
</summary>
<param name="logRecord">Log record data</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.ConversionExists(System.String,System.String)">
<summary>
Returns false if conversion does not exists
</summary>
<param name="conversionName">Conversion name</param>
<param name="siteName">Site name</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.GetCreationTimeFromFileName(System.String)">
<summary>
Returns creation time from file name.
</summary>
<param name="fileName">File name</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProcessor.RemoveMachineName(System.String)">
<summary>
Removes machine name from file name.
</summary>
<param name="fileName">File name.</param>
</member>
<member name="P:CMS.WebAnalytics.HitLogProcessor.TimeRegex">
<summary>
Regular expression for time format HHmm.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitLogProvider">
<summary>
HitLogProvider class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.PAGE_VIEWS">
<summary>
Page views code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.AGGREGATED_VIEWS">
<summary>
Aggregated page views code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.VISITORS_FIRST">
<summary>
First visitors code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.VISITORS_RETURNING">
<summary>
Returning visitors code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.FILE_DOWNLOADS">
<summary>
File downloads code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.PAGE_NOT_FOUND">
<summary>
Page not found code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.URL_REFERRALS">
<summary>
URL referrals code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.CONVERSIONS">
<summary>
Conversions code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.CAMPAIGNS">
<summary>
Campaigns code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.BROWSER_TYPE">
<summary>
Browser type code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.COUNTRIES">
<summary>
IP to country conversion code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.REGISTEREDUSER">
<summary>
Registered user code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.LANDINGPAGE">
<summary>
Landing page code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.EXITPAGECANDIDATE">
<summary>
Exit page candidate code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.EXITPAGE">
<summary>
Exit page code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.AVGTIMEONPAGE">
<summary>
Avg. time on page code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.REFERRINGSITE">
<summary>
Referring sites code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.SEARCHKEYWORD">
<summary>
Search keywords code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.ONSITESEARCHKEYWORD">
<summary>
On-site search keywords code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.OPERATINGSYSTEM">
<summary>
Operating system code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.SCREENCOLOR">
<summary>
Screen color code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.SCREENRESOLUTION">
<summary>
Screen resolution code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.FLASH">
<summary>
Flash code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.SILVERLIGHT">
<summary>
Silverlight code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.JAVA">
<summary>
Java code name.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.SEMICOLONDELIMITER">
<summary>
Constant used for loging semicolons
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.CRAWLER">
<summary>
Crawler code name
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.MOBILEDEVICE">
<summary>
Mobile device code name
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.mMemStorage">
<summary>
Static memory storage for web analytics
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.msLocker">
<summary>
Memory storage locker
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.mDomains">
<summary>
Table with domains and true/false values which indicate whether web analytics is allowed for a domain.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.mLogDirectory">
<summary>
Logs directory.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.mLockingTarget">
<summary>
Private locking object used when new entry is appended into the log file.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.locker">
<summary>
User pages locker.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitLogProvider.mUseMemoryStorage">
<summary>
Indicates whether memory storage should be used instead of direct file write
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogHit(System.String,System.String,System.String,System.String,System.Int32)">
<summary>
Writes the hit log to the file.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogHit(System.String,System.String,System.String,System.String,System.Int32,System.Double)">
<summary>
Writes the hit log to the file.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="value">Hit value</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogHit(System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
<summary>
Writes the hit log to the file.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="count">Hit count</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogHit(System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Double)">
<summary>
Writes the hit log to the file.
</summary>
<param name="codeName">Statistics codename</param>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="count">Hit count</param>
<param name="value">Hit value</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogPageView(System.String,System.String,System.String,System.Int32)">
<summary>
Writes the hit log to the file for page view.
Logs page view for the given page with the given culture.
</summary>
<param name="siteName">Site name</param>
<param name="culture">Document culture code</param>
<param name="objectName">Node alias path</param>
<param name="objectId">Node ID</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogConversions(System.String,System.String,System.String,System.Int32,System.Double)">
<summary>
Writes the hit log to the file for all available conversions.
</summary>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="value">Hit value</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.LogConversions(System.String,System.String,System.String,System.Int32,System.Int32,System.Double)">
<summary>
Writes the hit log to the file for all available conversions.
</summary>
<param name="siteName">Site name</param>
<param name="culture">Site culture code</param>
<param name="objectName">Object name</param>
<param name="objectId">Object ID</param>
<param name="count">Hit count</param>
<param name="value">Hit value</param>
</member>
<member name="M:CMS.WebAnalytics.HitLogProvider.IsDomainAllowed(System.String)">
<summary>
Returns true if web analytics is allowed for specified domain.
</summary>
<param name="domain">Domain name</param>
</member>
<member name="P:CMS.WebAnalytics.HitLogProvider.UseMemoryStorage">
<summary>
Gets the value that indicates whether memory storage should be used instead of direct file write
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitLogProvider.MemStorage">
<summary>
Gets the memory storage
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitLogProvider.Domains">
<summary>
Table with domains and true/false values which indicate whether web analytics is allowed for a domain.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitLogProvider.LogDirectory">
<summary>
Logs directory.
</summary>
</member>
<member name="T:CMS.WebAnalytics.MemoryStorage">
<summary>
Memory storage class provides a functionality to keep analytics records in memory during log phase
instead of immediate disk write.
</summary>
</member>
<member name="M:CMS.WebAnalytics.MemoryStorage.AppendAllText(System.String,System.String,System.DateTime)">
<summary>
Appends the string value to the specific virtual file and directory
</summary>
<param name="value">Value to store</param>
<param name="fileName">File name</param>
<param name="dirDate">Directory date</param>
</member>
<member name="M:CMS.WebAnalytics.MemoryStorage.GetDirectory(System.DateTime)">
<summary>
Returns virtual directory for specified name
</summary>
<param name="dirDate">Directory date</param>
</member>
<member name="M:CMS.WebAnalytics.MemoryStorage.SaveVirtualFiles(System.String)">
<summary>
Callback function from cache re
</summary>
<param name="dirName">Directory name</param>
</member>
<member name="M:CMS.WebAnalytics.MemoryStorage.#ctor(System.String,System.String)">
<summary>
Constructor to initialize storage
</summary>
<param name="storageName">Sets the storage name</param>
<param name="dirPath">Path to the physical directory</param>
</member>
<member name="P:CMS.WebAnalytics.MemoryStorage.StorageName">
<summary>
Gets or sets the storage name
</summary>
</member>
<member name="P:CMS.WebAnalytics.MemoryStorage.DirectoryPath">
<summary>
Physical directory path
</summary>
</member>
<member name="T:CMS.WebAnalytics.VirtualDirectory">
<summary>
Virtual directory class stores directories and their virtual files
</summary>
</member>
<member name="M:CMS.WebAnalytics.VirtualDirectory.SaveAllFiles">
<summary>
Saves all files in directory to the file system
</summary>
</member>
<member name="M:CMS.WebAnalytics.VirtualDirectory.AppendAllText(System.String,System.String)">
<summary>
Appends specified content to the file
</summary>
<param name="filename">File name</param>
<param name="content">String content</param>
</member>
<member name="M:CMS.WebAnalytics.VirtualDirectory.GetFile(System.String)">
<summary>
Returns stream writer representing specific file
</summary>
<param name="filename">File name</param>
</member>
<member name="M:CMS.WebAnalytics.VirtualDirectory.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="dirPath">Physical directory path</param>
</member>
<member name="P:CMS.WebAnalytics.VirtualDirectory.DirectoryPath">
<summary>
Physical directory path
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsInfo">
<summary>
HitsInfo data container class.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.HitsIntervalEnumString(CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Converts enum to database name.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.HitsIntervalEnumTableName(CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Converts enum to table name.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.#ctor">
<summary>
Constructor - Creates new object of HitsInfo with the year granularity
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.#ctor(CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Constructor - Creates new object of HitsInfo based on the enum.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.#ctor(System.Data.DataRow,CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Constructor - Creates a new HitsInfo object from the given DataRow.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.LoadTime(System.DateTime)">
<summary>
Sets the Hits start time and end time to the interval matching the given time.
If interval changed, clears the ID of the object.
</summary>
<param name="time">Time</param>
</member>
<member name="M:CMS.WebAnalytics.HitsInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsInfo.HitsID">
<summary>
Hits ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsInfo.HitsStatisticsID">
<summary>
Hits statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsInfo.HitsStartTime">
<summary>
Hits start time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsInfo.HitsEndTime">
<summary>
Hits end time.
</summary>
</member>
<member name="P:CMS.WebAnalytics.HitsInfo.HitsCount">
<summary>
Hits count.
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsInfoProvider">
<summary>
Class providing HitsInfo management.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetHitsInfo(System.Int32,CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Returns the HitsInfo structure for the specified hits.
</summary>
<param name="hitsId">Hits id</param>
<param name="interval">Hits interval enumerator</param>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetHitsInfo(System.DateTime,System.Int32,CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Returns the HitsInfo structure for the specified time.
</summary>
<param name="time">Time</param>
<param name="statisticsId">Statistics ID</param>
<param name="interval">Hits interval enumerator</param>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetAllHitsInfo(System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String,System.DateTime)">
<summary>
Returns all HitsInfo records for the specified time.
<param name="siteId">Site ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeName">Statistics type (pageviews, downloads...)</param>
<param name="time">Time</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetAllHitsInfo(System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String[],System.DateTime)">
<summary>
Returns all HitsInfo records for the specified time and categories.
<param name="siteId">Site ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeNames">Statistics type (pageviews, downloads...)</param>
<param name="time">Time</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetAllHitsInfoBetween(System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String,System.DateTime,System.DateTime,System.String,System.String,System.String)">
<summary>
Returns all HitsInfo records for the specified time.
<param name="siteId">Site ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeName">Statistics type (abvisit%, pageviews, downloads...) which is evaluated by LIKE operator</param>
<param name="startTime">Start date</param>
<param name="endTime">End date</param>
<param name="columns">Columns</param>
<param name="culture">Culture</param>
<param name="where">Additional where condition</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetAllHitsInfo(System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String,System.String,System.String,System.String)">
<summary>
Returns all HitsInfo records.
<param name="siteId">Site ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeName">Statistics type (abvisit%, pageviews, downloads...) which is evaluated by LIKE operator</param>
<param name="columns">Columns</param>
<param name="culture">Culture</param>
<param name="where">Additional where condition</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetAllHitsInfoBetween(System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String[],System.DateTime,System.DateTime,System.String)">
<summary>
Returns all HitsInfo records for the specified time and categories.
<param name="siteId">Site ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeNames">Statistics type (abvisit%, pageviews, downloads...) which is evaluated by LIKE operator</param>
<param name="startTime">Start date</param>
<param name="endTime">End date</param>
<param name="columns">Columns</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetObjectHitsInfo(System.Int32,System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String,System.DateTime,System.DateTime)">
<summary>
Returns all HitsInfo records for the specified object.
<param name="siteId">Site ID</param>
<param name="objectId">Object ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeName">Statistics type (pageviews, downloads...)</param>
<param name="timeBegin">Start of time interval (e.g. 01/01/2008)</param>
<param name="timeEnd">End of time interval (e.q. 12/31/2008)</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.GetObjectHitCount(System.Int32,System.Int32,CMS.WebAnalytics.HitsIntervalEnum,System.String,System.DateTime,System.DateTime)">
<summary>
Returns all HitsInfo records for the specified object.
<param name="siteId">Site ID</param>
<param name="objectId">Object ID</param>
<param name="interval">Hits interval (hour, day, week, year)</param>
<param name="codeName">Statistics type (pageviews, downloads...)</param>
<param name="timeBegin">Start of time interval (e.g. 01/01/2008)</param>
<param name="timeEnd">End of time interval (e.q. 12/31/2008)</param>
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.SetHitsInfo(CMS.WebAnalytics.HitsInfo)">
<summary>
Sets (updates or inserts) specified hits.
</summary>
<param name="hits">Hits to set</param>
</member>
<member name="M:CMS.WebAnalytics.HitsInfoProvider.DeleteHitsInfo(CMS.WebAnalytics.HitsInfo)">
<summary>
Deletes specified hits.
</summary>
<param name="hits">HitsInfo object</param>
</member>
<member name="T:CMS.WebAnalytics.HitsIntervalEnum">
<summary>
Hits interval type enumeration.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.Year">
<summary>
Year interval.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.Month">
<summary>
Month interval.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.Week">
<summary>
Week interval.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.Day">
<summary>
Day interval.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.Hour">
<summary>
Hour interval.
</summary>
</member>
<member name="F:CMS.WebAnalytics.HitsIntervalEnum.None">
<summary>
No interval
</summary>
</member>
<member name="T:CMS.WebAnalytics.HitsIntervalEnumFunctions">
<summary>
Class to provider safe conversion.
</summary>
</member>
<member name="M:CMS.WebAnalytics.HitsIntervalEnumFunctions.StringToHitsConversion(System.String)">
<summary>
Converts string to HitsIntervalEnum.
</summary>
<param name="value">Value to convert</param>
</member>
<member name="M:CMS.WebAnalytics.HitsIntervalEnumFunctions.HitsConversionToString(CMS.WebAnalytics.HitsIntervalEnum)">
<summary>
Converts HitsIntervalEnum to string.
</summary>
<param name="value">Value to convert</param>
</member>
<member name="T:CMS.WebAnalytics.StatisticsInfo">
<summary>
StatisticsInfo data container class.
</summary>
</member>
<member name="F:CMS.WebAnalytics.StatisticsInfo.OBJECT_TYPE">
<summary>
Object type
</summary>
</member>
<member name="F:CMS.WebAnalytics.StatisticsInfo.TYPEINFO">
<summary>
Type information.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfo.DeleteObject">
<summary>
Deletes the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfo.SetObject">
<summary>
Updates the object using appropriate provider.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfo.#ctor">
<summary>
Constructor - Creates an empty StatisticsInfo object.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfo.#ctor(System.Data.DataRow)">
<summary>
Constructor - Creates a new StatisticsInfo object from the given DataRow.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.ValidateCodeName">
<summary>
Indicates whether the codename should be validated upon saving.
It is set to false to circumvent semicolon checking in sample statistics generator.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsID">
<summary>
Statistics ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsCode">
<summary>
Statistics code.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsSiteID">
<summary>
Statistics site ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsObjectName">
<summary>
Statistics object name.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsObjectID">
<summary>
Statistics object ID.
</summary>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfo.StatisticsObjectCulture">
<summary>
Statistics object culture.
</summary>
</member>
<member name="T:CMS.WebAnalytics.StatisticsInfoProvider">
<summary>
Class providing StatisticsInfo management.
</summary>
</member>
<member name="F:CMS.WebAnalytics.StatisticsInfoProvider.deleterLock">
<summary>
Deleter lock
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetStatisticsInfo(System.Int32)">
<summary>
Returns the StatisticsInfo structure for the specified statistics.
</summary>
<param name="statisticsId">Statistics id</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetCodeNames">
<summary>
Retrieves all statistic code names.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetCodeNames(System.String,System.String,System.Int32)">
<summary>
Retrieves statistic code names under given condition.
</summary>
<param name="where">Where condition</param>
<param name="orderBy">Order by</param>
<param name="topN">Top N rows</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetStatistics">
<summary>
Returns a query for all the StatisticsInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.SetStatisticsInfo(CMS.WebAnalytics.StatisticsInfo)">
<summary>
Sets (updates or inserts) specified statistics.
</summary>
<param name="statistics">Statistics to set</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.DeleteStatisticsInfo(CMS.WebAnalytics.StatisticsInfo)">
<summary>
Deletes specified statistics.
</summary>
<param name="statisticsObj">Statistics object</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.DeleteStatisticsInfo(System.Int32)">
<summary>
Deletes specified statistics.
</summary>
<param name="statisticsId">Statistics id</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.DeleteStatisticsInfo(System.String)">
<summary>
Deletes all statistics with specified code name.
</summary>
<param name="statisticsCode">Statistics code name</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.RemoveAnalyticsData(System.DateTime,System.DateTime,System.Int32,System.String)">
<summary>
Removes analytics data for specified parameters
</summary>
<param name="from">From date</param>
<param name="to">To date</param>
<param name="siteId">Site id. If is 0, data from all sites are removed</param>
<param name="where">Where condition, if no all data to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.RemoveAnalyticsDataAsync(System.DateTime,System.DateTime,System.Int32,System.String)">
<summary>
Removes analytics data for specified parameters
</summary>
<param name="from">From date</param>
<param name="to">To date</param>
<param name="siteID">Site id. If is 0, data from all sites are removed</param>
<param name="where">Where condition, if no all data to be deleted</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetStatisticsInfoInternal(System.Int32)">
<summary>
Returns the StatisticsInfo structure for the specified statistics.
</summary>
<param name="statisticsId">Statistics id</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetCodeNamesInternal(System.String,System.String,System.Int32)">
<summary>
Retrieves statistic code names.
</summary>
<param name="where">Where condition</param>
<param name="orderBy">Order by</param>
<param name="topN">Top N rows</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.GetStatisticsInternal">
<summary>
Returns a query for all the StatisticsInfo objects.
</summary>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.SetStatisticsInfoInternal(CMS.WebAnalytics.StatisticsInfo)">
<summary>
Sets (updates or inserts) specified statistics.
</summary>
<param name="statistics">Statistics to set</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.DeleteStatisticsInfoInternal(CMS.WebAnalytics.StatisticsInfo)">
<summary>
Deletes specified statistics.
</summary>
<param name="statisticsObj">Statistics object</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.DeleteStatisticsInfoInternal(System.String)">
<summary>
Deletes all statistics with specified code name.
</summary>
<param name="statisticsCode">Statistics code name</param>
</member>
<member name="M:CMS.WebAnalytics.StatisticsInfoProvider.RemoveAnalyticsDataInternal(System.DateTime,System.DateTime,System.Int32,System.String)">
<summary>
Removes analytics data for specified parameters
</summary>
<param name="from">From date</param>
<param name="to">To date</param>
<param name="siteId">Site id. If is 0, data from all sites are removed</param>
<param name="where">Where condition, if no all data to be deleted</param>
</member>
<member name="P:CMS.WebAnalytics.StatisticsInfoProvider.DataDeleterIsRunning">
<summary>
Indicates whether data deleter is running
</summary>
</member>
<member name="T:CMS.WebAnalytics.VisitorNamespace">
<summary>
Wrapper class to provide Visitor namespace in the MacroEngine.
</summary>
</member>
<member name="T:CMS.WebAnalytics.IUTMEnqueuerService">
<summary>
Interface for UTM enqueuer service
</summary>
</member>
<member name="M:CMS.WebAnalytics.IUTMEnqueuerService.LogUTMParameters(System.String,System.String,System.String)">
<summary>
Inserts UTM parameters to Queue.
</summary>
<param name="campaignName">Campaign name</param>
<param name="conversionName">Conversion name</param>
<param name="sourceName">Source name</param>
</member>
<member name="T:CMS.WebAnalytics.UTMLogWorker">
<summary>
UTM parameters log worker. Takes information from UTM queue and processes them.
</summary>
</member>
<member name="M:CMS.WebAnalytics.UTMLogWorker.Finish">
<summary>
Finishes the worker process. Implement this method to specify what the worker must do in order to not lose its internal data when being finished. Leave empty if no extra action is required.
</summary>
</member>
<member name="M:CMS.WebAnalytics.UTMLogWorker.ProcessItem(CMS.WebAnalytics.ConversionCampaignSourceInfo)">
<summary>
Processing of single item. In this implementation this method is not called at all.
</summary>
<param name="item">Item to be processed.</param>
</member>
<member name="M:CMS.WebAnalytics.UTMLogWorker.ProcessItems(System.Collections.Generic.IEnumerable{CMS.WebAnalytics.ConversionCampaignSourceInfo})">
<summary>
Processes items from queue.
</summary>
</member>
<member name="P:CMS.WebAnalytics.UTMLogWorker.DefaultInterval">
<summary>
Gets the interval in milliseconds for the worker.
</summary>
</member>
<member name="T:CMS.WebAnalytics.DefaultUTMEnqueuerService">
<summary>
Service responsible for logging UTM parameters.
</summary>
</member>
<member name="M:CMS.WebAnalytics.DefaultUTMEnqueuerService.LogUTMParameters(System.String,System.String,System.String)">
<summary>
Inserts UTM parameters to Queue.
</summary>
<param name="campaignName">Campaign name</param>
<param name="conversionName">Conversion name</param>
<param name="sourceName">Source name</param>
</member>
<member name="T:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator">
<summary>
Contains methods for generating sample data for the Web analytics module.
</summary>
<exclude />
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.#ctor(CMS.SiteProvider.SiteInfo)">
<summary>
Constructor.
</summary>
<param name="site">Site the analytics will be generated for</param>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.Generate">
<summary>
Performs web analytics sample data generation.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.RegisterGenerators">
<summary>
Registers all methods generating the sample data to the output delegate.
</summary>
<returns>Delegates list containing all generators</returns>
</member>
<member name="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.StatisticCodeNames">
<summary>
Statistics code names being generated.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.Countries(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs countries obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mCountriesDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.RegisteredUsers(System.Random)">
<summary>
Iterates names in <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mNameDataSource"/> and log the name as registered user for random day in last month.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.MobileDevices(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs mobile devices obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mMobileDevicesDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.UrlReferrals(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs URL Referrals obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mReferralsDataSource"/>. Logs referring site as well (in this case the hits are aggregated by referral domain).
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.SearchEngines(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs search engines obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mSearchEnginesDataSource"/>. Logs search referring site as well.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.AggregatedViews(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Generates Aggregated views representing the views through RSS or atom feeds, therefore documents are filtered to match only Article type.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.FileDownloads(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs file downloads obtained from the <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mFileDownloadsDataSource"/>
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.VisitorsAndTopLandingAndExitPages(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Splits visitors between returning and the new ones. For the new visitors, logs first visit hit and both top and exit landing pages.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.OnSiteAndExternalKeywords(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs both on-site and external search keywords obtained from the <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mSearchKeywordDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.InvalidPages(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Picks random documents and alter their alias paths by adding space or removing some of the letters from the end of the path.
These paths are then logged as invalid ones.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.PageViewsAndAverageTimeOnPage(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Picks random documents for both cultures, distributes number of visitors across the pages while penalizing long document alias paths and logs page view. Logs average time on page for
every processed document as well as direct referring site.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.BrowserTypes(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs browser types obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mBrowsersDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.FlashJavaAndSilverligthSupport(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs support for Flash, Java and Silverlight.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.ThirdPartySupport(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random,System.Double,System.String,System.String,System.String)">
<summary>
Logs third party application support (usable for logging Flash, Java and Silverlight support).
</summary>
<param name="date">Date the hit will be assigned to</param>
<param name="visitors">Contains number of visitor per every culture</param>
<param name="random">Random number generator</param>
<param name="threshold">Relative threshold determining how many visitors do not support third party applications</param>
<param name="hitType">Codename of the statistics</param>
<param name="supportedValue">Value will be logged for the supporting visitors</param>
<param name="notsupportedValue">Value will be logged fo the not supporting visitors</param>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.OperatingSystems(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs browser types obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mOperatingSystemDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.ScreenColors(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs browser types obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mScreenColorDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.ScreenResolution(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs browser types obtained from <see cref="F:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.mScreenResolutionDataSource"/>.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.Conversions(System.DateTime,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Logs hits for top 6 conversions found within the site.
</summary>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.GetDataSourceFrequency(System.Collections.Generic.Dictionary{System.String,System.Int32})">
<summary>
Gets relative frequency of every item in <paramref name="input"/> on interval [0,1].
</summary>
<param name="input">Dictionary containing all data source items with their absolute frequency</param>
<returns>Computed relative frequency for every item in <paramref name="input"/></returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.GetRandomDataSourceValue(System.Collections.Generic.Dictionary{System.String,System.Int32},System.Random)">
<summary>
Gets random value from the <paramref name="input"/> while weight of every value is defined by its value in the input dictionary.
</summary>
<param name="input">Contains all the values the result will be picked from, where key is the output value and key is weight of the item</param>
<param name="random">Random number generator</param>
<returns>Single value randomly picked from <paramref name="input"/> with respect to the item weight.</returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.SplitVisitors(System.Double,System.Double,System.Random,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Collections.Generic.Dictionary{System.String,System.Int32}@)">
<summary>
Splits visitors given in <paramref name="visitors"/> according to <paramref name="threshold"/> with respect to <paramref name="variance"/>.
</summary>
<param name="threshold">Relative amount of visitors, where those for interval [0-threshold] are stored in <paramref name="belowThreshold"/>, while the rest in <paramref name="overThreshold"/></param>
<param name="variance">Specifies weight of the random variance added to the threshold</param>
<param name="random">Random number generator</param>
<param name="visitors">Input dictionary of visitors which will be splitted. Contains key value pair for every visitor culture</param>
<param name="belowThreshold">Out parameter where visitors below the threshold will be stored</param>
<param name="overThreshold">OUt parameter where visitors over the threshold will be stored</param>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.GetRelativeAmountOfVisitors(System.Double,System.Double,System.Random,System.Collections.Generic.Dictionary{System.String,System.Int32})">
<summary>
Gets relative amount of visitors from <paramref name="visitors"/> for each input culture.
</summary>
<param name="relativeAmount">Relative amount of visitors which will be returned. Has to be in interval [0,1]</param>
<param name="variance">Specifies weight of the random variance added to the threshold</param>
<param name="random">Random number generator</param>
<param name="visitors">Input dictionary of visitors from which the output will be obtained. Contains key value pair for every visitor culture</param>
<returns>Dictionary containing only relative amount of visitors from the <paramref name="visitors"/></returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.GetRandomValue(System.Random,System.Int32,System.Int32)">
<summary>
Gets pseudo-random number from the <paramref name="baseValue"/> vicinity. The least value returned is always 1.
</summary>
<param name="random">Random number generator</param>
<param name="baseValue">Specifies the base value of the result</param>
<param name="variance">Specifies how much does the result differ from <paramref name="baseValue"/></param>
<returns>Pseudo-random number in <paramref name="baseValue"/> vicinity</returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.GetRandomDocuments(System.Int32,System.Int32,System.String)">
<summary>
Gets <paramref name="numberOfEnglishDocuments"/> documents in English culture and <paramref name="numberOfSpanishDocuments"/> in Spanish culture from the current site.
</summary>
<param name="numberOfEnglishDocuments">Number of documents in English culture to be obtained</param>
<param name="numberOfSpanishDocuments">Number of documents in Spanish culture to be obtained</param>
<param name="documentType">Specifies filter of document types. Leave null for all document types</param>
<returns>Collection of randomly obtained documents from the current site</returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.Logit(System.Double)">
<summary>
Function, which maps interval [0,1] to whole real domain.
Input value is reduced to interval [1e-12, 1 - 1e-12] to avoid infinity or extreme large results.
</summary>
<param name="x">Input value.</param>
<returns>Product of Logit function on <paramref name="x"/></returns>
</member>
<member name="M:CMS.WebAnalytics.Internal.WebAnalyticsDataGenerator.LogHit(System.String,System.Int32,System.Int32,System.DateTime,System.String,System.String,System.Int32)">
<summary>
Performs logging of the hit.
</summary>
</member>
<member name="T:CMS.WebAnalytics.IWebAnalyticsServiceScriptsGenerator">
<summary>
Service for generating JavaScript code which is able to call the external web service via AJAX. Before using the generated JS snippet, you need
to manually create global WebServiceCall(url, method, parameters) JavaScript function either by calling ScriptHelper.RegisterWebServiceCallFunction(page) or
manually.
</summary>
</member>
<member name="M:CMS.WebAnalytics.IWebAnalyticsServiceScriptsGenerator.GetLogBannerHitScript(System.Int32)">
<summary>
Returns script which logs BannerHit asynchronously.
</summary>
<param name="bannerID">ID of the banner which was viewed</param>
</member>
<member name="M:CMS.WebAnalytics.IWebAnalyticsServiceScriptsGenerator.GetLogSearchScript(CMS.DocumentEngine.PageInfo,System.String)">
<summary>
Returns script which logs Search statistics asynchronously.
</summary>
<param name="pageInfo">PageInfo representing current document/node</param>
<param name="searchText">Text which was searched for</param>
</member>
<member name="M:CMS.WebAnalytics.IWebAnalyticsServiceScriptsGenerator.GetLogHitsScriptWithSubstitute(System.String)">
<summary>
Returns script which logs page views and other hits asynchronously. The script does not contain the actual parameters.
There is a placeholder at the location where parameters would be and this placeholder should be replaced by the actual parameters
before sending page output to the client browser. This two-step rendering is required, because of the output cache mechanism.
At first, there is a universal script rendered and saved into cache. This universal script is then updated with values specific
for the current request before sending HTTP response back to the client browser.
</summary>
<param name="substitute">String which will be placed at the location where parameters would normally be</param>
</member>
<member name="M:CMS.WebAnalytics.IWebAnalyticsServiceScriptsGenerator.GetLogHitsParameters(CMS.DocumentEngine.PageInfo,System.String)">
<summary>
Returns parameters of the LogHits call in JSON format.
</summary>
<param name="pageInfo">PageInfo representing current document/node. Cannot be null</param>
<param name="urlReferrer">Url of the page where the user came from (http referrer). Can be null</param>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer">
<summary>
Contains methods for registering JavaScript code into page which logs web analytics statistics asynchronously via call to WebAnalyticsService.
LogHits call is registered automatically for each page request. Other calls have to be registered manually.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.JAVASCRIPT_QUERYPARAMS_SUBSTITUTE">
<summary>
String to put into HTML to JavaScript code before substitution resolving.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.RegisterLogBannerHitCall(System.Web.UI.Page,System.Int32)">
<summary>
Registers script which logs banner hit asynchronously.
</summary>
<param name="page">Page where script should be registered</param>
<param name="bannerID">Banner which was viewed</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.RegisterLogSearchCall(System.Web.UI.Page,CMS.DocumentEngine.PageInfo,System.String)">
<summary>
Registers script which logs search hit asynchronously.
</summary>
<param name="page">Page where script should be registered</param>
<param name="pageInfo">PageInfo representing current document/node</param>
<param name="searchText">Text which was searched for</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.Init">
<summary>
Binds to appropriate events, so that LogHits call can be rendered on every page request.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.RegisterLogHitsCall(System.Object,System.EventArgs)">
<summary>
Registers script which logs page views and other hits asynchronously. The script is registered without the actual parameters.
There is a placeholder at the location where parameters would be and this placeholder should be replaced by the actual parameters
before sending page output to the client browser. This two-step rendering is required, because of the output cache mechanism.
At first, there is a universal script rendered and
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.ShouldInsertAnalyticsJS(System.String,System.String)">
<summary>
Checks whether the JavaScript logging snippet should be added to the page.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsRenderer.ResolveSubstitution(System.Object,CMS.OutputFilter.SubstitutionEventArgs)">
<summary>
Resolves JavaScript parameters substitution macro.
Substitution macro is used because of full page caching, JavaScript snippet is unique for each visitor, because of the Url Referrer parameter.
</summary>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator">
<summary>
Service for generating JavaScript code which is able to call the external web service via AJAX. Before using the generated JS snippet, you need
to manually create global WebServiceCall(url, method, parameters) JavaScript function either by calling ScriptHelper.RegisterWebServiceCallFunction(page) or
manually.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.PARAM_PAGE_NODE_ALIAS_PATH">
<summary>
Node alias path of the page the visitor requested.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.PARAM_PAGE_CULTURE_CODE">
<summary>
Culture code of the page the visitor requested.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.PARAM_REFERRER">
<summary>
Referrer query parameter name.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.GetLogBannerHitScript(System.Int32)">
<summary>
Returns script which logs BannerHit asynchronously.
</summary>
<param name="bannerID">ID of the banner which was viewed</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.GetLogSearchScript(CMS.DocumentEngine.PageInfo,System.String)">
<summary>
Returns script which logs Search statistics asynchronously.
</summary>
<param name="pageInfo">PageInfo representing current document/node</param>
<param name="searchText">Text which was searched for</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.GetLogHitsScriptWithSubstitute(System.String)">
<summary>
Returns script which logs page views and other hits asynchronously. The script does not contain the actual parameters.
There is a placeholder at the location where parameters would be and this placeholder should be replaced by the actual parameters
before sending page output to the client browser. This two-step rendering is required, because of the output cache mechanism.
At first, there is a universal script rendered and saved into cache. This universal script is then updated with values specific
for the current request before sending HTTP response back to the client browser.
</summary>
<param name="substitute">String which will be placed at the location where parameters would normally be</param>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsServiceScriptsGenerator.GetLogHitsParameters(CMS.DocumentEngine.PageInfo,System.String)">
<summary>
Returns parameters of the LogHits call in JSON format.
</summary>
<param name="pageInfo">PageInfo representing current document/node. Cannot be null</param>
<param name="urlReferrer">Url of the page where the user came from (http referrer). Can be null</param>
</member>
<member name="T:CMS.WebAnalytics.WebAnalyticsUSageDataSource">
<summary>
Module usage tracking data source for web analytics module.
</summary>
</member>
<member name="F:CMS.WebAnalytics.WebAnalyticsUSageDataSource.mSettingsToLog">
<summary>
Settings keyes which are logged.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsUSageDataSource.GetData">
<summary>
Get all module statistical data.
</summary>
</member>
<member name="M:CMS.WebAnalytics.WebAnalyticsUSageDataSource.GetSettingsUsage(System.Boolean)">
<summary>
Returns how many times is specific setting used with value which is not same as default value.
Only settings on running sites (if <paramref name="global"/> is true), not hidden and not custom are retrieved.
Only global settings when <paramref name="global"/> is false.
</summary>
</member>
<member name="P:CMS.WebAnalytics.WebAnalyticsUSageDataSource.Name">
<summary>
Get the data source name.
</summary>
</member>
</members>
</doc>