CMS.Blogs.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.Blogs</name> </assembly> <members> <member name="T:CMS.Blogs.BlogCommentActivityInitializer"> <summary> Provides initialization for Blog comment activity. </summary> </member> <member name="M:CMS.Blogs.BlogCommentActivityInitializer.#ctor(CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode,CMS.Blogs.BlogCommentInfo)"> <summary> Initializes new instance of <see cref="T:CMS.Blogs.BlogCommentActivityInitializer"/> </summary> <param name="blog">Blog node</param> <param name="blogPost">Blog post node</param> <param name="blogComment">Blog comment info</param> </member> <member name="M:CMS.Blogs.BlogCommentActivityInitializer.Initialize(CMS.Activities.IActivityInfo)"> <summary> Initializes <see cref="T:CMS.Activities.IActivityInfo"/> properties. </summary> <param name="activity">Activity info</param> </member> <member name="P:CMS.Blogs.BlogCommentActivityInitializer.ActivityType"> <summary> Activity type. </summary> </member> <member name="P:CMS.Blogs.BlogCommentActivityInitializer.SettingsKeyName"> <summary> Settings key name. </summary> </member> <member name="T:CMS.Blogs.BlogPostSubscriptionActivityInitializer"> <summary> Provides initialization for Blog post subscription activity. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionActivityInitializer.#ctor(CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode,CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Initializes new instance of <see cref="T:CMS.Blogs.BlogPostSubscriptionActivityInitializer"/> </summary> <param name="blog">Blog node</param> <param name="blogPost">Blog post node</param> <param name="blogPostSubscriptionInfo">Blog post subscription info</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionActivityInitializer.Initialize(CMS.Activities.IActivityInfo)"> <summary> Initializes <see cref="T:CMS.Activities.IActivityInfo"/> properties. </summary> <param name="activity">Activity info</param> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionActivityInitializer.ActivityType"> <summary> Activity type. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionActivityInitializer.SettingsKeyName"> <summary> Settings key name. </summary> </member> <member name="T:CMS.Blogs.BlogsActivityLogger"> <summary> Provides methods for logging blogs activities. </summary> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.LogBlogCommentActivity(CMS.Blogs.BlogCommentInfo)"> <summary> Logs Blog comment activity. </summary> <param name="blogCommentInfo"><see cref="T:CMS.Blogs.BlogCommentInfo"/> to log</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="blogCommentInfo"/> is <c>null</c>.</exception> <exception cref="T:System.ArgumentException">Thrown when blog post or blog of <paramref name="blogCommentInfo"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.LogBlogPostSubscriptionActivity(CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Logs Blog post subscription. </summary> <param name="blogPostSubscriptionInfo"><see cref="T:CMS.Blogs.BlogPostSubscriptionInfo"/> to log</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="blogPostSubscriptionInfo"/> is <c>null</c>.</exception> <exception cref="T:System.ArgumentException">Thrown when blog post or blog of <paramref name="blogPostSubscriptionInfo"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.LogBlogPostSubscriptionActivity(CMS.Blogs.BlogPostSubscriptionInfo,System.Int32,System.Int32,System.String)"> <summary> Logs Blog post subscription. </summary> <param name="blogPostSubscriptionInfo"><see cref="T:CMS.Blogs.BlogPostSubscriptionInfo"/> to log</param> <param name="contactId">Contact to log activity for</param> <param name="siteId">Site to log activity for</param> <param name="campaign">Campaign to log activity for</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="blogPostSubscriptionInfo"/> is <c>null</c>.</exception> <exception cref="T:System.ArgumentException">Thrown when blog post or blog of <paramref name="blogPostSubscriptionInfo"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.GetParentBlog(System.Int32)"> <summary> Gets parent blog of the specified document. </summary> <param name="documentId">Document ID</param> <returns></returns> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.GetBlogPost(System.Int32)"> <summary> Gets current document version of the specified document. </summary> <param name="documentId">Document ID</param> <returns></returns> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.GetCurrentRequest"> <summary> Returns current request. </summary> <returns>Current request.</returns> </member> <member name="M:CMS.Blogs.BlogsActivityLogger.LogActivityIfEnabled(CMS.Activities.IActivityInitializer,System.Boolean)"> <summary> Calls <see cref="T:CMS.Activities.IActivityLogService"/> and logs the activity using the given <paramref name="activityInitializer"/> if logging of on-line marketing activities is enabled on given blog post. </summary> <param name="activityInitializer">Activity initializer used to initialize logged activity</param> <param name="logActivity">Flag from given blog post specifying whether the logging of on-line marketing activities is enabled</param> </member> <member name="T:CMS.Blogs.BlogCommentInfo"> <summary> BlogCommentInfo data container class. </summary> </member> <member name="F:CMS.Blogs.BlogCommentInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Blogs.BlogCommentInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentInfo"> <summary> Post ip, and agent values. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentDate"> <summary> Comment date and time. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentUrl"> <summary> Comment url. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentText"> <summary> Comment text. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentEmail"> <summary> Comment e-mail. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentUserID"> <summary> Comment user ID. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentIsSpam"> <summary> Comment is spam. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentApproved"> <summary> Comment is approved. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentApprovedByUserID"> <summary> Comment approved by user ID. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentID"> <summary> Comment ID. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentGUID"> <summary> Comment GUID. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentUserName"> <summary> Comment user name. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfo.CommentPostDocumentID"> <summary> Comment post document ID. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfo.#ctor"> <summary> Constructor - Creates an empty BlogCommentInfo object. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new BlogCommentInfo object from the given DataRow. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfo.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="T:CMS.Blogs.BlogCommentInfoProvider"> <summary> Class providing BlogCommentInfo management. </summary> </member> <member name="P:CMS.Blogs.BlogCommentInfoProvider.EnableEmails"> <summary> Indicates if e-mails are allowed to be sent to subscribers and moderators, by default it is set to True. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetBlogCommentInfo(System.Int32)"> <summary> Returns the BlogCommentInfo structure for the specified blogComment. </summary> <param name="blogCommentId">BlogComment id</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.SetBlogCommentInfo(CMS.Blogs.BlogCommentInfo)"> <summary> Sets (updates or inserts) specified blog comment. </summary> <param name="blogComment">Blog comment to set</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.DeleteBlogCommentInfo(CMS.Blogs.BlogCommentInfo)"> <summary> Deletes specified blogComment. </summary> <param name="blogCommentObj">BlogComment object</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.DeleteBlogCommentInfo(System.Int32)"> <summary> Deletes specified blogComment. </summary> <param name="blogCommentId">BlogComment id</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetBlogComments"> <summary> Returns object query for blog comments. </summary> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetAllComments(System.String,System.String,System.Int32,System.String)"> <summary> Returns all comments. </summary> <param name="where">Where condition to filter data</param> <param name="orderBy">Order by statement</param> <param name="topN">Specifies number of returned records</param> <param name="columns">Data columns to return</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetAllComments(System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Returns all comments. </summary> <param name="where">Where condition to filter data</param> <param name="orderBy">Order by statement</param> <param name="topN">Specifies number of returned records</param> <param name="columns">Data columns to return</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetCommentsWaitingForApproval(System.String,System.Int32)"> <summary> Returns DataSet with all owner comments waiting for approval. </summary> <param name="siteName">Site name</param> <param name="ownerID">Owner ID</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetComments(System.Int32,System.String,System.String,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@,System.String)"> <summary> Returns DataSet with all comments which belongs to the specified user or which are moderated by specified user. </summary> <param name="ownerId">Blog owner (user id)</param> <param name="moderator">Blog moderator (user name)</param> <param name="where">Where condition which specifies comments to be returned</param> <param name="blogWhere">Where condition which specifies blogs the comments should be returned from</param> <param name="columns">Columns to be selected</param> <param name="topN">Selects only top N items</param> <param name="order">Order by</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> <param name="siteName">Site name of the blog</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetPostComments(System.Int32,System.Boolean,System.Boolean)"> <summary> Returns DataSet with post comments which are not marked as spam. </summary> <param name="postDocumentId">Post documentID</param> <param name="onlyApproved">Indicates if only approved comments should be returned</param> <param name="includingSpam">Indicates if comments which are marked as SPAM should be included in the result</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetPostCommentsCount(System.Int32,System.Boolean,System.Boolean)"> <summary> Returns count of the post comments. </summary> <param name="postDocumentId">Post documentID</param> <param name="onlyApproved">Indicates if only approved comments should be included in the count</param> <param name="includingSpam">Indicates if comments which are marked as SPAM should be included in the count</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.SendNewCommentNotification(CMS.Blogs.BlogCommentInfo,System.Boolean,System.Boolean,System.Boolean)"> <summary> Sends a notification e-mail to blog post subscribers, to blog moderators and to blog owner. </summary> <param name="comment">Blog comment data</param> <param name="toSubscribers">Indicates if notification email should be sent to blog post subscribers</param> <param name="toModerators">Indicates if notification email should be sent to blog moderators</param> <param name="toBlogOwner">Indicates if notification email should be sent to blog owner</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetApprovedComments(System.Int32)"> <summary> Return all blog comments for specified document </summary> <param name="documentId">Document ID</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetCommentsWhereCondition(System.Int32,System.Boolean,System.Boolean)"> <summary> Returns WHERE condition for the comments selection according to the specified parameters. </summary> <param name="postDocumentId">Post document ID</param> <param name="onlyApproved">Indicates if only approved comments should be included</param> <param name="includingSpam">Indicates if comments which are marked as SPAM should be included</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetCommentSiteName(System.Int32)"> <summary> Returns sitename with dependence on selected document id. </summary> <param name="documentId">Document id</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.SetBlogCommentInfoInternal(CMS.Blogs.BlogCommentInfo)"> <summary> Sets (updates or inserts) specified blog comment. </summary> <param name="blogComment">Blog comment to set</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.DeleteBlogCommentInfoInternal(CMS.Blogs.BlogCommentInfo)"> <summary> Deletes specified blogComment. </summary> <param name="blogCommentObj">BlogComment object</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetCommentsWaitingForApprovalInternal(System.String,System.Int32)"> <summary> Returns DataSet with all owner comments waiting for approval. </summary> <param name="siteName">Site name</param> <param name="ownerID">Owner ID</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetCommentsInternal(System.Int32,System.String,System.String,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@,System.String)"> <summary> Returns DataSet with all comments which belongs to the specified user or which are moderated by specified user. </summary> <param name="ownerId">Blog owner (user id)</param> <param name="moderator">Blog moderator (user name)</param> <param name="where">Where condition which specifies comments to be returned</param> <param name="blogWhere">Where condition which specifies blogs the comments should be returned from</param> <param name="columns">Columns to be selected</param> <param name="topN">Selects only top N items</param> <param name="order">Order by</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> <param name="siteName">Site name of the blog</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetPostCommentsInternal(System.Int32,System.Boolean,System.Boolean)"> <summary> Returns DataSet with post comments which are not marked as spam. </summary> <param name="postDocumentId">Post documentID</param> <param name="onlyApproved">Indicates if only approved comments should be returned</param> <param name="includingSpam">Indicates if comments which are marked as SPAM should be included in the result</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.GetPostCommentsCountInternal(System.Int32,System.Boolean,System.Boolean)"> <summary> Returns count of the post comments. </summary> <param name="postDocumentId">Post document ID</param> <param name="onlyApproved">Indicates if only approved comments should be included in the count</param> <param name="includingSpam">Indicates if comments which are marked as SPAM should be included in the count</param> </member> <member name="M:CMS.Blogs.BlogCommentInfoProvider.SendNewCommentNotificationInternal(CMS.Blogs.BlogCommentInfo,System.Boolean,System.Boolean,System.Boolean)"> <summary> Sends a notification e-mail to blog post subscribers, to blog moderators and to blog owner. </summary> <param name="comment">Blog comment data</param> <param name="toSubscribers">Indicates if notification email should be sent to blog post subscribers</param> <param name="toModerators">Indicates if notification email should be sent to blog moderators</param> <param name="toBlogOwner">Indicates if notification email should be sent to blog owner</param> </member> <member name="T:CMS.Blogs.BlogHelper"> <summary> Class providing blog helper methods. </summary> </member> <member name="F:CMS.Blogs.BlogHelper.BLOG_OBJECT_TYPE"> <summary> Object type for Blog page type </summary> </member> <member name="F:CMS.Blogs.BlogHelper.BLOG_CLASS_NAME"> <summary> Class name for Blog page type </summary> </member> <member name="M:CMS.Blogs.BlogHelper.GetParentBlog(System.Int32,System.Boolean)"> <summary> Returns parent blog of the specified document. </summary> <param name="documentId">Document ID</param> <param name="selectOnlyPublished">Select only published</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetParentBlog(System.String,System.String,System.Boolean)"> <summary> Returns parent blog of the specified document. </summary> <param name="aliasPath">Alias path</param> <param name="siteName">Site name</param> <param name="selectOnlyPublished">Select only published</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetBlogPosts(System.String,System.String,System.String,System.Boolean,System.String,System.String,System.Boolean)"> <summary> Returns DataSet with all posts from all blogs. </summary> <param name="siteName">Nodes site name</param> <param name="aliasPath">Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL)</param> <param name="cultureCode">Nodes culture code</param> <param name="combineWithDefaultCulture">Specifies if return the default culture document when specified culture not found</param> <param name="where">Where condition to use for parent blogs selection</param> <param name="orderBy">Order by clause to use for the data selection</param> <param name="selectOnlyPublished">Select only published nodes</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetCommentParentBlog(System.Int32,System.Boolean)"> <summary> Returns parent blog of the specified comment. </summary> <param name="commentId">Comment id</param> <param name="selectOnlyPublished">Select only published</param> </member> <member name="M:CMS.Blogs.BlogHelper.IsUserBlogModerator(System.String,CMS.DocumentEngine.TreeNode)"> <summary> Determines if user is moderator of the specified blog. </summary> <param name="userName">User name</param> <param name="blogNode">Blog node (tree node of type 'cms.blog')</param> </member> <member name="M:CMS.Blogs.BlogHelper.IsUserBlogOwner(System.Int32,CMS.DocumentEngine.TreeNode)"> <summary> Determines if user is owner of the specified blog. </summary> <param name="userId">User ID</param> <param name="blogNode">Blog node (tree node of type 'cms.blog')</param> </member> <member name="M:CMS.Blogs.BlogHelper.IsUserAuthorizedToManageComments(CMS.DocumentEngine.TreeNode,System.Boolean)"> <summary> Checks if the current user is allowed to manage comments of the blog placed on specified node. </summary> <param name="blogNode">Node the blog resides at</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetBlogs(System.String,System.Int32,System.String,System.String,System.String)"> <summary> Returns all blogs from specified site, optionally owned by specified user or moderated by specified user. </summary> <param name="siteName">Site name</param> <param name="ownerId">Blog owner (user ID)</param> <param name="moderator">Blog moderator (user name)</param> <param name="columns">Columns to be selected</param> <param name="customWhere">Additional WHERE condition</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetBlogsWhere(System.Int32,System.String,System.String)"> <summary> Returns combined where condition using given ownerId, moderator name and custom where condition. </summary> <param name="ownerId">Blog owner (user ID)</param> <param name="moderator">Blog moderator (user name)</param> <param name="customWhere">Additional WHERE condition</param> </member> <member name="M:CMS.Blogs.BlogHelper.GetBlogDoubleOptInInterval(System.String)"> <summary> Get blog double opt-in interval from settings </summary> <param name="siteName">Site name of related settings</param> </member> <member name="M:CMS.Blogs.BlogHelper.BlogOptInEnabled(CMS.DocumentEngine.TreeNode)"> <summary> Indicates if opt-in is enabled for blog </summary> <param name="blog">Blog document to check</param> </member> <member name="M:CMS.Blogs.BlogHelper.CreateMacroResolver(CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode)"> <summary> Creates macro resolver </summary> <param name="blog">Blog tree node</param> <param name="blogPost">Blog post tree node</param> </member> <member name="T:CMS.Blogs.BlogResolvers"> <summary> Resolvers used in e-mail templates and other macro visual components. </summary> </member> <member name="P:CMS.Blogs.BlogResolvers.BlogResolver"> <summary> Blog e-mail template macro resolver. </summary> </member> <member name="P:CMS.Blogs.BlogResolvers.BlogSubscriptionResolver"> <summary> Blog e-mail template macro resolver. </summary> </member> <member name="T:CMS.Blogs.BlogsModuleMetadata"> <summary> Represents the Blogs module metadata. </summary> </member> <member name="M:CMS.Blogs.BlogsModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.Blogs.BlogHandlers"> <summary> Provides handlers for blogs </summary> </member> <member name="M:CMS.Blogs.BlogHandlers.Init"> <summary> Initializes the blog handlers </summary> </member> <member name="M:CMS.Blogs.BlogHandlers.GetContent_Execute(System.Object,CMS.DocumentEngine.DocumentSearchEventArgs)"> <summary> Includes blog content to the document search content </summary> </member> <member name="T:CMS.Blogs.BlogExport"> <summary> Handles special actions during the Blog export process. </summary> </member> <member name="M:CMS.Blogs.BlogExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="M:CMS.Blogs.BlogExport.RegisterTranslationRecords(System.Data.DataSet,CMS.DataEngine.TranslationHelper,System.String[])"> <summary> Ensure translation records registration. </summary> <param name="data">Source dataset</param> <param name="th">Translation helper</param> <param name="excludedNames">Excluded object names</param> </member> <member name="T:CMS.Blogs.BlogImport"> <summary> Handles special actions during the Blog import process. </summary> </member> <member name="M:CMS.Blogs.BlogImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="M:CMS.Blogs.BlogImport.ProcessMainObject_Before(System.Object,CMS.CMSImportExport.ImportEventArgs)"> <summary> Removes not supported fields for Trackbacks from CommentView web part </summary> </member> <member name="M:CMS.Blogs.BlogImport.ProcessMainObject_After(System.Object,CMS.CMSImportExport.ImportEventArgs)"> <summary> Removes not supported fields from Blog and Blog post page types. </summary> </member> <member name="M:CMS.Blogs.BlogImport.GetImportData_After(System.Object,CMS.CMSImportExport.ImportGetDataEventArgs)"> <summary> Removes old not supported setting keys and form controls for MetaWeblog API and Trackbacks </summary> </member> <member name="M:CMS.Blogs.BlogImport.RemoveFieldsFromFormDefinition(System.String,System.Collections.Generic.List{System.String})"> <summary> Removes fields from form definition and returns new definition </summary> <param name="formDefinition"></param> <param name="fields">List of fields to remove</param> </member> <member name="T:CMS.Blogs.ImportSpecialActions"> <summary> Handles special actions during the import process. </summary> </member> <member name="M:CMS.Blogs.ImportSpecialActions.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.Blogs.BlogPostSubscriptionInfo"> <summary> BlogPostSubscriptionInfo data container class. </summary> </member> <member name="F:CMS.Blogs.BlogPostSubscriptionInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Blogs.BlogPostSubscriptionInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionPostDocumentID"> <summary> Subscription post document ID. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionEmail"> <summary> Subscription e-mail. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionID"> <summary> Subscription ID. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionGUID"> <summary> Subscription GUID. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionLastModified"> <summary> Subscription last modified. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionUserID"> <summary> Subsription user ID. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionApproved"> <summary> Indicates if subscription approved. </summary> </member> <member name="P:CMS.Blogs.BlogPostSubscriptionInfo.SubscriptionApprovalHash"> <summary> Subscription approval hash code. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfo.#ctor"> <summary> Constructor - Creates an empty BlogPostSubscriptionInfo object. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new BlogPostSubscriptionInfo object from the given DataRow. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfo.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="T:CMS.Blogs.BlogPostSubscriptionInfoProvider"> <summary> Class providing BlogPostSubscriptionInfo management. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptionInfo(System.Int32)"> <summary> Returns the BlogPostSubscriptionInfo structure for the specified blogPostSubscriptionId. </summary> <param name="blogPostSubscriptionId">Blog post subscription ID</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptionInfo(System.Guid)"> <summary> Returns the BlogPostSubscriptionInfo structure for the subscriber specified by its GUID. </summary> <param name="guid">Subscriber GUID</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptions"> <summary> Gets the query for all blog post subscriptions. </summary> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptionInfo(System.String,System.Int32)"> <summary> Returns blog post subscription info for specified email and blog post. </summary> <param name="email">Subscriber e-mail</param> <param name="documentId">Blog post document ID</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptionInfo(System.String)"> <summary> Returns blog post subscription info for specified subscription hash. </summary> <param name="subscriptionHash">Subscription hash</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptions(System.Int32,System.Int32,System.String,System.Int32)"> <summary> Returns all blog post subscriptions for specified user which were created on specified site. Blog post document name is attached for each subscription. </summary> <param name="userId">User ID</param> <param name="siteId">Site ID</param> <param name="where">WHERE condition</param> <param name="topN">TOP N query parameter</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptions(System.Int32,System.Int32,System.String,System.Int32,System.String,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Returns all blog post subscriptions for specified user which were created on specified site. Blog post document name is attached for each subscription. </summary> <param name="userId">User ID</param> <param name="siteId">Site ID</param> <param name="where">WHERE condition</param> <param name="topN">TOP N query parameter</param> <param name="columns">Columns expression</param> <param name="order">Order by</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetBlogPostSubscriptions(System.String,System.String,System.String)"> <summary> Returns all subscriptions info with specified parameters. </summary> <param name="where">WHERE condition</param> <param name="orderby">ORDER BY</param> <param name="columns">Selected columns</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.SetBlogPostSubscriptionInfo(CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Sets (updates or inserts) specified blogPostSubscription. </summary> <param name="blogPostSubscription">BlogPostSubscription to set</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.DeleteBlogPostSubscriptionInfo(CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Deletes specified blog post subscription. </summary> <param name="infoObj">BlogPostSubscription object</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.DeleteBlogPostSubscriptionInfo(System.Int32)"> <summary> Deletes specified blogPostSubscription. </summary> <param name="blogPostSubscriptionId">BlogPostSubscription id</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.SendConfirmationEmail(CMS.Blogs.BlogPostSubscriptionInfo,System.Boolean)"> <summary> Sends subscription or unsubscription confirmation mail. </summary> <param name="blogSubscription">Blog post subscription info</param> <param name="isSubscription">If true subscription email is sent else unsubscription email is sent</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.SendDoubleOptInEmail(CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Sends double opt-in mail. </summary> <param name="blogSubscription">Blog post subscription info</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.Subscribe(CMS.Blogs.BlogPostSubscriptionInfo,System.DateTime,System.Boolean,System.Boolean)"> <summary> Subscribe method intend to subscribe user to blog post and send confirmation/opt-in email </summary> <param name="bpsi">Subscription to be saved</param> <param name="when">Time of subscription</param> <param name="sendConfirmationEmail">Indicates if confirmation email should be send</param> <param name="sendOptInEmail">Indicates if opt-in email should be send</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.ValidateHash(CMS.Blogs.BlogPostSubscriptionInfo,System.String,System.String,System.DateTime)"> <summary> Validates request hash and checks if request was approved in needed interval. </summary> <param name="bpsi">Blog post subscription info.</param> <param name="requestHash">Hash parameter representing specific subscription</param> <param name="datetime">Date and time of request.</param> <param name="siteName">Site name.</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetUnsubscriptionUrl(CMS.Blogs.BlogPostSubscriptionInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode,System.String)"> <summary> Returns unsubscription URL which is used to cancel existing subscription </summary> <param name="subscription">Blog post subscription object</param> <param name="blog">Blog document</param> <param name="blogPost">Blog post to which user was subscribed</param> <param name="unsubscriptionUrl">Custom unsubscription page URL</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetActivationUrl(CMS.Blogs.BlogPostSubscriptionInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode)"> <summary> Returns approval page URL to confirm blog post subscription. </summary> <param name="subscription">Forum subscription object</param> <param name="blog">Blog document</param> <param name="blogPost">Blog post to which user was subscribed</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.ApproveSubscription(CMS.Blogs.BlogPostSubscriptionInfo,System.String,System.Boolean,System.String,System.DateTime)"> <summary> Approves existing subscription - sets SubscriptionApproved to true. Checks if subscription wasn't already approved. Confirmation e-mail may be sent optionally. </summary> <param name="bpsi">Blog post subscription</param> <param name="subscriptionHash">Hash parameter representing specific subscription</param> <param name="sendConfirmationEmail">Indicates if confirmation e-mail should be sent. Confirmation e-mail may also be sent if blog settings requires so</param> <param name="datetime">Date and time of request.</param> <param name="siteName">Site name.</param> <returns>Returns TRUE if subscription found and not already approved. Returns FALSE if subscription not found or already approved.</returns> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.Unsubscribe(System.String,System.Boolean,System.String,System.DateTime)"> <summary> Unsubscribes user from blog post. </summary> <param name="subscriptionHash">Subscription hash.</param> <param name="sendConfirmationEmail">Indicates whether send confirmation e-mail</param> <param name="datetime">Date and time of request</param> <param name="siteName">Site name.</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.DeleteInfo(CMS.Blogs.BlogPostSubscriptionInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.SendConfirmationEmailInternal(CMS.Blogs.BlogPostSubscriptionInfo,System.Boolean,System.Boolean)"> <summary> Sends subscription or unsubscription confirmation mail. </summary> <param name="blogSubscription">Blog post subscription info</param> <param name="isSubscription">If true subscription email is sent else unsubscription email is sent</param> <param name="isOptIn">Indicates if opt-in email should be sent</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.SubscribeInternal(CMS.Blogs.BlogPostSubscriptionInfo,System.DateTime,System.Boolean,System.Boolean)"> <summary> Subscribe method intend to subscribe user to blog post and send confirmation/opt-in email </summary> <param name="bpsi">Subscription to be saved</param> <param name="when">Time of subscription</param> <param name="sendConfirmationEmail">Indicates if confirmation email should be send</param> <param name="sendOptInEmail">Indicates if opt-in email should be send</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.ValidateHashInternal(CMS.Blogs.BlogPostSubscriptionInfo,System.String,System.String,System.DateTime)"> <summary> Validates request hash and checks if request was approved in needed interval. </summary> <param name="bpsi">Blog post subscription info.</param> <param name="requestHash">Hash parameter representing specific subscription</param> <param name="datetime">Date and time of request.</param> <param name="siteName">Site name.</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetUnsubscriptionUrlInternal(CMS.Blogs.BlogPostSubscriptionInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode,System.String)"> <summary> Returns unsubscription URL which is used to cancel existing subscription </summary> <param name="subscription">Blog post subscription object</param> <param name="blog">Blog document</param> <param name="blogPost">Blog post to which user was subscribed</param> <param name="unsubscriptionUrl">Custom unsubscription page URL</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.GetActivationUrlInternal(CMS.Blogs.BlogPostSubscriptionInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode)"> <summary> Returns approval page URL to confirm blog post subscription. </summary> <param name="subscription">Forum subscription object</param> <param name="blog">Blog document</param> <param name="blogPost">Blog post to which user was subscribed</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.ApproveSubscriptionInternal(CMS.Blogs.BlogPostSubscriptionInfo,System.String,System.Boolean,System.String,System.DateTime)"> <summary> Approves existing subscription - sets SubscriptionApproved to true. Checks if subscription wasn't already approved. Confirmation e-mail may be sent optionally. </summary> <param name="bpsi">Blog post subscription</param> <param name="subscriptionHash">Hash parameter representing specific subscription</param> <param name="sendConfirmationEmail">Indicates if confirmation e-mail should be sent. Confirmation e-mail may also be sent if blog settings requires so</param> <param name="datetime">Date and time of request.</param> <param name="siteName">Site name.</param> <returns>Returns TRUE if subscription found and not already approved. Returns FALSE if subscription not found or already approved.</returns> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.UnsubscribeInternal(System.String,System.Boolean,System.String,System.DateTime)"> <summary> Unsubscribes user from blog post. </summary> <param name="subscriptionHash">Subscription hash.</param> <param name="sendConfirmationEmail">Indicates whether send confirmation e-mail</param> <param name="datetime">Date and time of request</param> <param name="siteName">Site name.</param> </member> <member name="M:CMS.Blogs.BlogPostSubscriptionInfoProvider.CreateMacroResolver(CMS.Blogs.BlogPostSubscriptionInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode,System.String,System.Boolean,System.Boolean)"> <summary> Creates and initializes macro resolver. </summary> <param name="blogSubscription">Blog post subscription object</param> <param name="blog">Blog tree node</param> <param name="blogPost">Blog post tree node</param> <param name="siteName">Site name of the blog post</param> <param name="isSubscription">Indicates if resolver is created for subscription</param> <param name="isOptIn">Indicates if resolver is created for double opt-in</param> </member> <member name="T:CMS.Blogs.BlogProperties"> <summary> Class providing blog properties. </summary> </member> <member name="F:CMS.Blogs.BlogProperties.OPEN_COMMENTS_ALWAYS"> <summary> Indicates that comments are always opened after the blog post is published. </summary> </member> <member name="F:CMS.Blogs.BlogProperties.OPEN_COMMENTS_DISABLE"> <summary> Indicates that comments are closed after the blog post is published. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.OpenCommentsFor"> <summary> Indicates how long are comments opened. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.ModerateComments"> <summary> Indicates whether comments are moderated before publishing. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.ShowEditButton"> <summary> Indicates whether 'Edit' button should be displayed in comment view while editing comments on the live site. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.ShowDeleteButton"> <summary> Indicates whether 'Delete' button should be displayed in comment view while editing comments on the live site. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.SendCommentsToEmail"> <summary> E-mail address the comments are sent to. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.AllowAnonymousComments"> <summary> Indicates whether anonymous comments are allowed. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.UseCaptcha"> <summary> Indicates whether security code should be entered when inserting new comment. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.CheckPermissions"> <summary> Indicates whether permissions should be checked. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.StopProcessing"> <summary> Indicates whether processing should be stopped. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.EnableUserPictures"> <summary> Indicates whether user pictures should be displayed in comment detail. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.UserPictureMaxWidth"> <summary> User picture max width. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.UserPictureMaxHeight"> <summary> User picture max height. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.EnableSubscriptions"> <summary> Indicates whether subscription is allowed. </summary> </member> <member name="P:CMS.Blogs.BlogProperties.RequireEmails"> <summary> Indicates whether e-mail is required. </summary> </member> <member name="T:CMS.Blogs.BlogsModule"> <summary> Represents the Blogs module. </summary> </member> <member name="F:CMS.Blogs.BlogsModule.BLOG_EMAIL_TEMPLATE_TYPE_NAME"> <summary> Name of email template type for blog. </summary> </member> <member name="F:CMS.Blogs.BlogsModule.BLOG_SUBSCRIPTION_EMAIL_TEMPLATE_TYPE_NAME"> <summary> Name of email template type for blog subscription. </summary> </member> <member name="M:CMS.Blogs.BlogsModule.#ctor"> <summary> Default constructor </summary> </member> <member name="M:CMS.Blogs.BlogsModule.OnInit"> <summary> Initializes the module. </summary> </member> <member name="M:CMS.Blogs.BlogsModule.InitMacros"> <summary> Initializes blog macros </summary> </member> <member name="M:CMS.Blogs.BlogsModule.InitImportExport"> <summary> Initializes blog import/export actions </summary> </member> <member name="T:CMS.Blogs.ThreadEmailSender"> <summary> Handles sending message blog e-mails in separated thread. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.CommentObj"> <summary> Blog comment information. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.Moderators"> <summary> List of users' names. These users represents blog moderators. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.BlogOwnerEmail"> <summary> Blog owner e-mail address where the new comment notification should be sent. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.Subscribers"> <summary> Holds the information on subscribers e-mail is being sent to. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.EmailToModerators"> <summary> E-mail message to blog moderators and blog owner. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.EmailToSubscribers"> <summary> E-mail message to blog subscribers. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.EmailToOwner"> <summary> E-mail message to blog owner. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.OwnerResolver"> <summary> Resolver to use. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.SubscribersResolver"> <summary> Resolver to use for subscribers notifications. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.SiteName"> <summary> Name of the site the blog post is placed on. </summary> </member> <member name="P:CMS.Blogs.ThreadEmailSender.UnsubscriptionURL"> <summary> Resolved unsubscription URL. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.#ctor(CMS.Blogs.BlogCommentInfo)"> <summary> Constructor - creates and initialize email sender. </summary> <param name="blogComment">Blog comment information</param> </member> <member name="M:CMS.Blogs.ThreadEmailSender.InitSender(CMS.Blogs.BlogCommentInfo)"> <summary> Init sender private data and resolver. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.CreateMacroResolver(CMS.Membership.UserInfo,CMS.DocumentEngine.TreeNode,CMS.DocumentEngine.TreeNode)"> <summary> Creates and initializes macro resolver. </summary> <param name="user">User info object</param> <param name="blog">Blog node info object</param> <param name="blogPost">Blog post info object</param> </member> <member name="M:CMS.Blogs.ThreadEmailSender.GetEmailMessage(System.Boolean,System.Boolean,System.Boolean)"> <summary> Returns initialized e-mail message without recipients and with unresolved macros. </summary> <param name="toSubscribers">Indicates if notification email should be sent to blog post subscribers</param> <param name="toModerators">Indicates if notification email should be sent to blog moderators</param> <param name="toOwner">Indicates if notification email should be sent to blog owner</param> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendNotificationToSubscribers"> <summary> Sends e-mail notification to all blog post subscribers. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendNotificationToOwner"> <summary> Sends e-mail notification to blog owner. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendNotificationToModerators"> <summary> Sends e-mail notification to blog moderators. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendToOwner"> <summary> Sends e-mail to blog owner. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendToModerators"> <summary> Sends e-mails to blog moderators. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendToSubscribers"> <summary> Sends e-mails to blog post subscribers. </summary> </member> <member name="M:CMS.Blogs.ThreadEmailSender.ResolveEmailMacros(CMS.EmailEngine.EmailMessage)"> <summary> Resolves e-mail subject, body and plain text body. </summary> <param name="email">Email to be resolved</param> </member> <member name="M:CMS.Blogs.ThreadEmailSender.SendNewCommentNotification(System.Security.Principal.WindowsIdentity,System.Boolean,System.Boolean,System.Boolean)"> <summary> Sends a notification e-mail to blog post subscribers, to blog moderators and to blog owner. </summary> <param name="wi">Windows identity</param> <param name="toSubscribers">Indicates if notification email should be sent to blog post subscribers</param> <param name="toModerators">Indicates if notification email should be sent to blog moderators</param> <param name="toBlogOwner">Indicates if notification email should be sent to blog owner</param> </member> </members> </doc> |