CMS.Forums.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.Forums</name> </assembly> <members> <member name="T:CMS.Forums.ForumActivityLogger"> <summary> Provides methods for forum activities logging. </summary> </member> <member name="M:CMS.Forums.ForumActivityLogger.LogForumSubscriptionActivity(CMS.Forums.ForumInfo,CMS.Forums.ForumSubscriptionInfo,CMS.DocumentEngine.TreeNode)"> <summary> Logs forum subscription activity. </summary> <param name="forumInfo">Forum info</param> <param name="forumSubscriptionInfo">Forum subscription info</param> <param name="currentDocument">Current document</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="forumInfo"/> or <paramref name="forumSubscriptionInfo"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Forums.ForumActivityLogger.LogForumPostActivity(CMS.Forums.ForumInfo,CMS.Forums.ForumPostInfo,CMS.DocumentEngine.TreeNode)"> <summary> Logs forum post activity. </summary> <param name="forumInfo">Forum info</param> <param name="forumPostInfo">Forum post info</param> <param name="currentDocument">Current document</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="forumInfo"/> or <paramref name="forumPostInfo"/> or <paramref name="currentDocument"/> is <c>null</c>.</exception> </member> <member name="T:CMS.Forums.ForumPostActivityInitializer"> <summary> Represents initializer for forum post. </summary> </member> <member name="M:CMS.Forums.ForumPostActivityInitializer.#ctor(CMS.Forums.ForumInfo,CMS.Forums.ForumPostInfo,CMS.DocumentEngine.TreeNode)"> <summary> Initializes new instance of <see cref="T:CMS.Forums.ForumPostActivityInitializer"/>. </summary> <param name="forumInfo">Forum info</param> <param name="forumPostInfo">Forum post info</param> <param name="currentDocument">Current document</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="forumInfo"/> or <paramref name="forumPostInfo"/> or <paramref name="currentDocument"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Forums.ForumPostActivityInitializer.Initialize(CMS.Activities.IActivityInfo)"> <summary> Initializes <see cref="T:CMS.Activities.IActivityInfo"/> properties. </summary> <param name="activity">Activity info</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="activity"/> is <c>null</c>.</exception> </member> <member name="P:CMS.Forums.ForumPostActivityInitializer.ActivityType"> <summary> Activity type </summary> </member> <member name="P:CMS.Forums.ForumPostActivityInitializer.SettingsKeyName"> <summary> Activity settings key name, used to check whether activity logging is enabled. </summary> </member> <member name="T:CMS.Forums.ForumSubscriptionActivityInitializer"> <summary> Represents initializer for forum subscription. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionActivityInitializer.#ctor(CMS.Forums.ForumInfo,CMS.Forums.ForumSubscriptionInfo,CMS.DocumentEngine.TreeNode)"> <summary> Initializes new instance of <see cref="T:CMS.Forums.ForumSubscriptionActivityInitializer"/>. </summary> <param name="forumInfo">Forum info</param> <param name="forumSubscriptionInfo">Forum subscription info</param> <param name="currentDocument">Current document</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="forumInfo"/> or <paramref name="forumSubscriptionInfo"/> is <c>null</c>.</exception> </member> <member name="M:CMS.Forums.ForumSubscriptionActivityInitializer.Initialize(CMS.Activities.IActivityInfo)"> <summary> Initializes <see cref="T:CMS.Activities.IActivityInfo"/> properties. </summary> <param name="activity">Activity info</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="activity"/> is <c>null</c>.</exception> </member> <member name="P:CMS.Forums.ForumSubscriptionActivityInitializer.ActivityType"> <summary> Activity type </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionActivityInitializer.SettingsKeyName"> <summary> Activity settings key name, used to check whether activity logging is enabled. </summary> </member> <member name="T:CMS.Forums.CMSOutputForumAttachment"> <summary> Summary description for CMSOutputFile. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.ForumAttachment"> <summary> Forum attachment info without AttachmentBinary. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.OutputData"> <summary> Output file data. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.LastModified"> <summary> Time when the file was last modified. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.RedirectTo"> <summary> If set, file should be redirected to the file system. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.Width"> <summary> Requested output width. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.Height"> <summary> Requested output Height. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.MaxSideSize"> <summary> Requested output MaxSideSize. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.DataLoaded"> <summary> Returns true if the data is loaded to the object. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.MimeType"> <summary> Mime type. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.PhysicalFile"> <summary> Physical file path to the data. </summary> </member> <member name="P:CMS.Forums.CMSOutputForumAttachment.Resized"> <summary> If true, the file is resized version of the file. </summary> </member> <member name="M:CMS.Forums.CMSOutputForumAttachment.#ctor"> <summary> Constructor. </summary> </member> <member name="M:CMS.Forums.CMSOutputForumAttachment.#ctor(CMS.Forums.ForumAttachmentInfo,System.Byte[])"> <summary> Constructor. </summary> <param name="fi">ForumAttachment info</param> <param name="data">Output file data</param> </member> <member name="M:CMS.Forums.CMSOutputForumAttachment.EnsureData(System.Byte[])"> <summary> Ensures that the object contains the output data. </summary> <param name="defaultData">Default data which should be loaded if data required</param> <returns>Returns true if new data has been loaded</returns> </member> <member name="M:CMS.Forums.CMSOutputForumAttachment.LoadData(System.Byte[])"> <summary> Loads the data to the object. </summary> <param name="data">New data</param> </member> <member name="T:CMS.Forums.ForumContext"> <summary> Forum context. </summary> </member> <member name="M:CMS.Forums.ForumContext.GetUserModeratedForums(System.Int32)"> <summary> Returns hashtable with current user forums in which is moderator, key = forum id. </summary> <param name="userId">User ID</param> </member> <member name="P:CMS.Forums.ForumContext.UserIsModeratorInSomeForum"> <summary> Returns true if current user is moderator in at least one forum. </summary> </member> <member name="M:CMS.Forums.ForumContext.IsCommunityGroupAdmin(System.Int32,CMS.Membership.UserInfo)"> <summary> Returns true if specified user is group admin for selected forum. </summary> <param name="forumId">Forum ID</param> <param name="user">User info</param> </member> <member name="M:CMS.Forums.ForumContext.IsCommunityGroupAdmin(System.Int32)"> <summary> Returns true if current user is group admin for selected forum. </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumContext.UserIsModerator(System.Int32,System.Int32,CMS.Membership.UserInfo)"> <summary> Returns true if specified user is moderator of current forum. </summary> <param name="forumID">Forum ID</param> <param name="communityGroupId">Community group ID</param> <param name="user">User info object</param> </member> <member name="M:CMS.Forums.ForumContext.UserIsModerator(System.Int32,System.Int32)"> <summary> Returns true if current user is moderator of current forum. </summary> <param name="forumID">Forum ID</param> <param name="communityGroupId">Community group ID</param> </member> <member name="M:CMS.Forums.ForumContext.CheckSite(System.Int32,System.Int32,System.Int32)"> <summary> Checks if current post, forum or group is belong to current site. You have to insert at least one ID other parameters could be zero. </summary> <param name="groupID">Forum group id object.</param> <param name="forumID">Forum id object.</param> <param name="postID">Post id object.</param> </member> <member name="P:CMS.Forums.ForumContext.CurrentForumDiscussionMacroHelper"> <summary> Gets Discussion macro helper for current forum. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentState"> <summary> Gets the current forum mode. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentMode"> <summary> Gets current forum mode. </summary> </member> <member name="P:CMS.Forums.ForumContext.SiteID"> <summary> Gets or sets the site ID. </summary> </member> <member name="P:CMS.Forums.ForumContext.GroupID"> <summary> Gets or sets the group id based on current settings. </summary> </member> <member name="P:CMS.Forums.ForumContext.ForumID"> <summary> Gets or sets the forum id base on current url or settings. </summary> </member> <member name="P:CMS.Forums.ForumContext.CommunityGroupID"> <summary> Gets or sets community group id. </summary> </member> <member name="P:CMS.Forums.ForumContext.ThreadID"> <summary> Gets or sets the thread id based on current url or settings. </summary> </member> <member name="P:CMS.Forums.ForumContext.ReplyThreadID"> <summary> Gets or sets the forum id base on current url or settings. </summary> </member> <member name="P:CMS.Forums.ForumContext.SubscribeThreadID"> <summary> Gets or sets the forum id base on current url or settings. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentSubscribeThread"> <summary> Returns curren reply thread info. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentReplyThread"> <summary> Returns curren reply thread info. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentForum"> <summary> Returns current forum. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentThread"> <summary> Returns current thread. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentPost"> <summary> Returns current post for edit or attachment. </summary> </member> <member name="P:CMS.Forums.ForumContext.CurrentGroup"> <summary> Returns current thread. </summary> </member> <member name="M:CMS.Forums.ForumContext.RegisterProperties"> <summary> Registers the properties of this object </summary> </member> <member name="M:CMS.Forums.ForumContext.GetCurrentGroup"> <summary> Gets the current forum group </summary> </member> <member name="T:CMS.Forums.ForumStateEnum"> <summary> Enumeration of forum state. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Forums"> <summary> Forums. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Threads"> <summary> Threads. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Thread"> <summary> Thread. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.NewThread"> <summary> New thread. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.ReplyToPost"> <summary> Reply to post. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.NewSubscription"> <summary> New subscription. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.SubscribeToPost"> <summary> Subscription to post. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.EditPost"> <summary> Edit post. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Attachments"> <summary> Attachment page. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.AccessDenied"> <summary> Access denied. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Search"> <summary> Search. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.TopicMove"> <summary> Topic move. </summary> </member> <member name="F:CMS.Forums.ForumStateEnum.Unknown"> <summary> Unknown. </summary> </member> <member name="T:CMS.Forums.ForumMode"> <summary> Forum modes. </summary> </member> <member name="F:CMS.Forums.ForumMode.Edit"> <summary> Edit. </summary> </member> <member name="F:CMS.Forums.ForumMode.Attachment"> <summary> Attachment. </summary> </member> <member name="F:CMS.Forums.ForumMode.Quote"> <summary> Quote. </summary> </member> <member name="F:CMS.Forums.ForumMode.TopicMove"> <summary> Topic move. </summary> </member> <member name="F:CMS.Forums.ForumMode.Unknown"> <summary> Unknown. </summary> </member> <member name="T:CMS.Forums.ForumActionType"> <summary> Forum action type. </summary> </member> <member name="F:CMS.Forums.ForumActionType.NewThread"> <summary> NewThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Delete"> <summary> Delete. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Edit"> <summary> Edit. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Reply"> <summary> Reply. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Quote"> <summary> Quote. </summary> </member> <member name="F:CMS.Forums.ForumActionType.SubscribeToPost"> <summary> SubscribeToPost. </summary> </member> <member name="F:CMS.Forums.ForumActionType.SubscribeToForum"> <summary> </summary> </member> <member name="F:CMS.Forums.ForumActionType.Attachment"> <summary> Attachment. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Appprove"> <summary> Appprove. </summary> </member> <member name="F:CMS.Forums.ForumActionType.ApproveAll"> <summary> ApproveAll. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Reject"> <summary> Reject. </summary> </member> <member name="F:CMS.Forums.ForumActionType.RejectAll"> <summary> RejectAll. </summary> </member> <member name="F:CMS.Forums.ForumActionType.LockForum"> <summary> LockForum. </summary> </member> <member name="F:CMS.Forums.ForumActionType.UnlockForum"> <summary> UnlockForum. </summary> </member> <member name="F:CMS.Forums.ForumActionType.LockThread"> <summary> LockThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.UnlockThread"> <summary> UnlockThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.StickThread"> <summary> StickThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.UnstickThread"> <summary> UnstickThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.MoveStickyThreadUp"> <summary> MoveStickyThreadUp. </summary> </member> <member name="F:CMS.Forums.ForumActionType.MoveStickyThreadDown"> <summary> MoveStickyThreadDown. </summary> </member> <member name="F:CMS.Forums.ForumActionType.IsAnswer"> <summary> IsAnswer. </summary> </member> <member name="F:CMS.Forums.ForumActionType.IsNotAnswer"> <summary> IsNotAnswer. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Forum"> <summary> Forum. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Thread"> <summary> Thread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.SplitThread"> <summary> SplitThread. </summary> </member> <member name="F:CMS.Forums.ForumActionType.MoveToTheOtherForum"> <summary> MoveToTheOtherForum. </summary> </member> <member name="F:CMS.Forums.ForumActionType.AddPostToFavorites"> <summary> AddPostToFavorites. </summary> </member> <member name="F:CMS.Forums.ForumActionType.AddForumToFavorites"> <summary> AddForumToFavorites. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Badge"> <summary> Badge. </summary> </member> <member name="F:CMS.Forums.ForumActionType.ForumGroup"> <summary> Forum Group. </summary> </member> <member name="F:CMS.Forums.ForumActionType.Unknown"> <summary> Unknown. </summary> </member> <member name="T:CMS.Forums.ShowModeEnum"> <summary> ShowMode enum. </summary> </member> <member name="F:CMS.Forums.ShowModeEnum.TreeMode"> <summary> Tree mode. </summary> </member> <member name="F:CMS.Forums.ShowModeEnum.DetailMode"> <summary> Detail mode. </summary> </member> <member name="F:CMS.Forums.ShowModeEnum.DynamicDetailMode"> <summary> Dynamic detail mode </summary> </member> <member name="T:CMS.Forums.FlatModeEnum"> <summary> FlatMode enum. </summary> </member> <member name="F:CMS.Forums.FlatModeEnum.Threaded"> <summary> Tree mode. </summary> </member> <member name="F:CMS.Forums.FlatModeEnum.NewestToOldest"> <summary> Detail mode. </summary> </member> <member name="F:CMS.Forums.FlatModeEnum.OldestToNewest"> <summary> Dynamic detail mode </summary> </member> <member name="T:CMS.Forums.ForumModes"> <summary> Summary description for ForumModes. </summary> </member> <member name="M:CMS.Forums.ForumModes.GetShowMode(System.String)"> <summary> Returns the layout mode based on the given string. </summary> </member> <member name="M:CMS.Forums.ForumModes.GetFlatMode(System.String)"> <summary> Returns the layout mode based on the given string. </summary> </member> <member name="T:CMS.Forums.GetForumAttachmentHandler"> <summary> Handles requests for forum attachment files. </summary> </member> <member name="F:CMS.Forums.GetForumAttachmentHandler.useClientCache"> <summary> Sets to false to disable the client caching. </summary> </member> <member name="F:CMS.Forums.GetForumAttachmentHandler.largeFilesCacheMinutes"> <summary> Sets to 0 if you do not wish to cache large files. </summary> </member> <member name="P:CMS.Forums.GetForumAttachmentHandler.AllowCache"> <summary> Returns true if the process allows cache. </summary> </member> <member name="M:CMS.Forums.GetForumAttachmentHandler.ProcessRequestInternal(System.Web.HttpContextBase)"> <summary> Processes the handler request </summary> <param name="context">Handler context</param> </member> <member name="M:CMS.Forums.GetForumAttachmentHandler.ProcessFile"> <summary> Processes the file. </summary> </member> <member name="M:CMS.Forums.GetForumAttachmentHandler.SendFile(CMS.Forums.CMSOutputForumAttachment)"> <summary> Sends the given file within response. </summary> <param name="file">File to send</param> </member> <member name="M:CMS.Forums.GetForumAttachmentHandler.GetOutputDataDependency(CMS.Forums.ForumAttachmentInfo)"> <summary> Returns the output data dependency based on the given attachment record. </summary> <param name="fi">ForumAttachmentInfo object</param> </member> <member name="M:CMS.Forums.GetForumAttachmentHandler.EnsurePhysicalFile(CMS.Forums.CMSOutputForumAttachment)"> <summary> Ensures the physical file. </summary> <param name="file">Output file</param> </member> <member name="T:CMS.Forums.ForumHandlers"> <summary> Provides handlers for forums </summary> </member> <member name="M:CMS.Forums.ForumHandlers.Init"> <summary> Initializes the blog handlers </summary> </member> <member name="M:CMS.Forums.ForumHandlers.GetContent_Execute(System.Object,CMS.DocumentEngine.DocumentSearchEventArgs)"> <summary> Includes forums content to the document search content </summary> </member> <member name="T:CMS.Forums.Internal.ForumSearchablesRetriever"> <summary> Helps with retrieving <see cref="T:CMS.DataEngine.ISearchable"/> objects and <see cref="T:CMS.Search.SearchIndexInfo"/>s related to forum search. </summary> <seealso cref="M:CMS.Search.Internal.SearchablesRetrievers.Register``1(System.String)"/> </member> <member name="M:CMS.Forums.Internal.ForumSearchablesRetriever.GetRelevantIndexes(CMS.DataEngine.ISearchable,System.String)"> <summary> Gets the list of indexes relevant to the given object </summary> <param name="searchObject">Search object</param> <param name="searchProvider"> Defines search provider for which to return relevant indexes. If not defined then indexes for all search providers are returned. </param> <seealso cref="P:CMS.Search.SearchIndexInfo.IndexProvider"/> </member> <member name="T:CMS.Forums.ForumSearchIndexer"> <summary> Search indexer for forums </summary> </member> <member name="M:CMS.Forums.ForumSearchIndexer.#ctor"> <summary> Forum search indexer. </summary> </member> <member name="M:CMS.Forums.ForumSearchIndexer.Rebuild(CMS.Search.SearchIndexInfo)"> <summary> Rebuilds the forum index </summary> <remarks>This method needs to be run in a thread safe way such as smart search task queue.</remarks> <param name="indexInfo">Search index</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.SelectSearchDocument(System.Int32)"> <summary> Selects the search document based on the given ID </summary> <param name="documentId">Document ID</param> <returns>Enumeration of searchable objects or empty enumeration.</returns> </member> <member name="M:CMS.Forums.ForumSearchIndexer.CheckResultPermissions(CMS.Search.SearchResults,CMS.Search.ILuceneSearchDocument,System.Int32)"> <summary> Checks the permissions for the given result document </summary> <param name="settings">Check permission settings</param> <param name="currentDoc">Current result document</param> <param name="index">Current document index</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.LoadResults(System.Collections.Generic.IEnumerable{CMS.Search.ILuceneSearchDocument},CMS.Base.SafeDictionary{System.String,System.Data.DataRow})"> <summary> Loads the results to the given result collection </summary> <param name="results">Collection of results to load</param> <param name="result">Dictionary of the loaded results indexed by their key</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.GetDataClassInfo(CMS.Search.ILuceneSearchDocument)"> <summary> Returns the data class info for the given search document </summary> <param name="obj">Document object</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.GetSearchImageUrl(System.String,System.String,System.String)"> <summary> Returns URL to current search result item. </summary> <param name="id">ID of the item</param> <param name="type">Type of the index</param> <param name="image">Image</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.GetSearchFields(CMS.Search.SearchIndexInfo,CMS.DataEngine.ISearchFields)"> <summary> Gets the collection of search fields. When no SearchFields colection is provided, new is created. </summary> <param name="index">Search index</param> <param name="searchFields">Search fields collection</param> </member> <member name="M:CMS.Forums.ForumSearchIndexer.IsClassNameRelevantToIndex(System.String,CMS.DataEngine.SearchIndexSettings)"> <summary> Checks if given <paramref name="className"/> is related to search index settings from <paramref name="indexSettings"/>. </summary> <param name="className">Class name</param> <param name="indexSettings">Search index settings</param> </member> <member name="T:CMS.Forums.ForumsModuleMetadata"> <summary> Represents the Forums module metadata. </summary> </member> <member name="M:CMS.Forums.ForumsModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.Forums.ForumsResolvers"> <summary> Resolvers used in e-mail templates and other macro visual components. </summary> </member> <member name="P:CMS.Forums.ForumsResolvers.ForumResolver"> <summary> Forums e-mail template macro resolver. </summary> </member> <member name="P:CMS.Forums.ForumsResolvers.ForumSubscribtionResolver"> <summary> Forums subscription e-mail template macro resolver. </summary> </member> <member name="T:CMS.Forums.ForumExport"> <summary> Handles special actions during the forum export process. </summary> </member> <member name="M:CMS.Forums.ForumExport.Init"> <summary> Initializes export handlers </summary> </member> <member name="M:CMS.Forums.ForumExport.ExportForumPosts(CMS.CMSImportExport.SiteExportSettings,System.Data.DataTable,System.Boolean)"> <summary> Export forum posts. </summary> <param name="settings">Export settings</param> <param name="table">Parent data</param> <param name="groupPosts">Indicates if the posts are exported for group forums</param> </member> <member name="T:CMS.Forums.ForumImport"> <summary> Handles special actions during the forum import process. </summary> </member> <member name="M:CMS.Forums.ForumImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="M:CMS.Forums.ForumImport.ImportForumPosts(CMS.CMSImportExport.SiteImportSettings,System.Data.DataTable,CMS.DataEngine.TranslationHelper,System.Boolean)"> <summary> Import forum posts. </summary> <param name="settings">Import settings</param> <param name="table">Parent data</param> <param name="th">Translation helper</param> <param name="groupPosts">Indicates if the posts are imported for group forums</param> </member> <member name="T:CMS.Forums.ImportSpecialActions"> <summary> Handles special actions during the import process. </summary> </member> <member name="M:CMS.Forums.ImportSpecialActions.Init"> <summary> Initializes export handlers </summary> </member> <member name="T:CMS.Forums.ForumsSynchronization"> <summary> Web farm synchronization for Forums </summary> </member> <member name="P:CMS.Forums.ForumsSynchronization.SynchronizeForumAttachments"> <summary> Gets or sets value that indicates whether file synchronization for forum attachments is enabled. </summary> </member> <member name="M:CMS.Forums.ForumsSynchronization.Init"> <summary> Initializes the tasks for media files synchronization </summary> </member> <member name="M:CMS.Forums.ForumsSynchronization.CheckSynchronizeForumAttachments(CMS.Core.IWebFarmTask)"> <summary> Returns true if the synchronization of the forum attachments is allowed </summary> </member> <member name="M:CMS.Forums.ForumsSynchronization.CheckSynchronizeDeleteForumAttachments(CMS.Core.IWebFarmTask)"> <summary> Returns true if the synchronization of the deletion of the forum attachments is allowed </summary> </member> <member name="M:CMS.Forums.ForumsSynchronization.UpdateForumAttachment(System.String,System.String[],CMS.Core.BinaryData)"> <summary> Updates the forum attachment </summary> <param name="target">Task target</param> <param name="data">Task data</param> <param name="binaryData">Task binary data</param> </member> <member name="M:CMS.Forums.ForumsSynchronization.DeleteForumAttachment(System.String,System.String[],CMS.Core.BinaryData)"> <summary> Updates the forum attachment </summary> <param name="target">Task target</param> <param name="data">Task data</param> <param name="binaryData">Task binary data</param> </member> <member name="T:CMS.Forums.ForumsTaskType"> <summary> Web farm task types for Forums module </summary> </member> <member name="F:CMS.Forums.ForumsTaskType.UpdateForumAttachment"> <summary> Update forum attachment. </summary> </member> <member name="F:CMS.Forums.ForumsTaskType.DeleteForumAttachment"> <summary> Delete forum attachment. </summary> </member> <member name="F:CMS.Forums.ForumSubscriptionWithPostInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumSubscriptionWithPostInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionWithPostInfo.#ctor"> <summary> Constructor - Creates an empty ForumSubscriptionWithPostInfo object. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionWithPostInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumSubscriptionWithPostInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.Forums.ForumSubscriptionWithPostInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionWithPostInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.Forums.ThreadViewsProcessor"> <summary> Provides an ITask interface for automatic thread views processing (saving the data to DB). </summary> </member> <member name="M:CMS.Forums.ThreadViewsProcessor.Execute(CMS.Scheduler.TaskInfo)"> <summary> Executes the save action. </summary> <param name="task">Task to process</param> </member> <member name="T:CMS.Forums.ForumAttachmentInfo"> <summary> ForumAttachment data container class. </summary> </member> <member name="F:CMS.Forums.ForumAttachmentInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumAttachmentInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.Forums.ForumAttachmentInfo.mInputStreamData"> <summary> Input stream avatar data. </summary> </member> <member name="F:CMS.Forums.ForumAttachmentInfo.mStreamProcessed"> <summary> Indicates whether the data from input stream were processed. </summary> </member> <member name="F:CMS.Forums.ForumAttachmentInfo.mAttachmentForumId"> <summary> Current attachment forum id. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentSiteID"> <summary> Attachment site ID. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentFileSize"> <summary> File size. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentFileName"> <summary> File name. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentBinary"> <summary> Binary data. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentPostID"> <summary> ID of post which is associated with attachment. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentID"> <summary> Attachment ID. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentFileExtension"> <summary> File extension. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentLastModified"> <summary> Time of last modification. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentMimeType"> <summary> Mime type. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentGUID"> <summary> Attachment GUID. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentImageHeight"> <summary> Image height. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentImageWidth"> <summary> Image width. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfo.AttachmentForumID"> <summary> Gets the attachment forum ID. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.GetCacheDependencies"> <summary> Gets collection of dependency keys to be touched when modifying the current object. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.GetDependencyCacheKeys"> <summary> Gets collection of dependency keys to be touched when modifying the current object. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.#ctor"> <summary> Constructor - Creates an empty ForumAttachment object. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumAttachment object from the given DataRow. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.#ctor(System.String,System.Int32,System.Int32,System.Int32)"> <summary> Constructor - Creates a new ForumAttachment object based on the file posted through the upload control. </summary> <param name="filePath">Path to the file</param> <param name="maxWidth">Maximal image width</param> <param name="maxHeight">Maximal image height</param> <param name="maxSideSize">Maximal side size</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.#ctor(System.Web.HttpPostedFile,System.Int32,System.Int32,System.Int32)"> <summary> Constructor - Creates a new ForumAttachment object based on the file posted through the upload control. </summary> <param name="postedFile">Posted file</param> <param name="maxWidth">Maximal image width</param> <param name="maxHeight">Maximal image height</param> <param name="maxSideSize">Maximal side size</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfo.RemoveObjectDependencies(System.Boolean,System.Boolean)"> <summary> Removes object dependencies. </summary> </member> <member name="T:CMS.Forums.ForumAttachmentInfoProvider"> <summary> Class providing ForumAttachment management. </summary> </member> <member name="P:CMS.Forums.ForumAttachmentInfoProvider.WebApplicationPhysicalPath"> <summary> Full path to the root of the web. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.UpdateData(System.String,System.String,CMS.DataEngine.QueryDataParameters)"> <summary> Updates data for all records given by where condition </summary> <param name="updateExpression">Update expression, e.g. "Value = Value * 2"</param> <param name="where">Where condition</param> <param name="parameters">Parameters</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachments"> <summary> Returns a query for all the ForumAttachmentInfo objects. </summary> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentInfoByGuid(System.Guid,System.String)"> <summary> Returns the ForumAttachment structure for the specified forumAttachment. </summary> <param name="guid">Forum attachment guid</param> <param name="siteName">Attachemnt site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentInfoWithoutBinary(System.Guid,System.String)"> <summary> Returns the ForumAttachment structure for the specified forumAttachment. </summary> <param name="guid">GUID of the forumAttachment to return</param> <param name="siteName">Attachment site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentInfo(System.Int32)"> <summary> Returns the ForumAttachment structure for the specified forumAttachment. </summary> <param name="forumAttachmentId">ForumAttachment id</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.SetForumAttachmentInfo(CMS.Forums.ForumAttachmentInfo)"> <summary> Sets (updates or inserts) specified forumAttachment. </summary> <param name="forumAttachment">ForumAttachmentInfo to set</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.DeleteForumAttachmentInfo(CMS.Forums.ForumAttachmentInfo)"> <summary> Deletes specified forumAttachment. </summary> <param name="infoObj">ForumAttachmentInfo object</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.DeleteForumAttachmentInfo(System.Int32)"> <summary> Deletes specified forumAttachment. </summary> <param name="forumAttachmentId">ForumAttachment id</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.DeleteFiles(System.String,System.String)"> <summary> Delete files in file system, with dependence on where condition. </summary> <param name="where">Where condition</param> <param name="siteName">Site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachments(System.Int32,System.Boolean)"> <summary> Returns DataSet with attachment which have relation to specified forum post id. </summary> <param name="postId">Forum post id</param> <param name="getBinary">If true binary data will be retrieved from DB</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachments(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset with attachments with dependence on input parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Top N</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.IsExtensionAllowed(System.String,System.String)"> <summary> Returns true if file extension is allowed. </summary> <param name="filename">File name with extension</param> <param name="siteName">Site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.DeleteAttachmentFile(System.String,System.String,System.Boolean,System.Boolean)"> <summary> Delete forum attachment file stored in the file system. </summary> <param name="siteName">Site name</param> <param name="attachmentFileName">Name of the file to be deleted</param> <param name="deleteDirectory">Determines whether delete specified directory or not</param> <param name="synchronization">Indicates whether the method is called due to synchronization</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetAttachmentFile(System.Guid,System.String)"> <summary> Returns the attachment file from disk or (if not available on the disk) from database. </summary> <param name="guid">Guid of the attachment file to get</param> <param name="siteName">Attachment site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetAttachmentFile(CMS.Forums.ForumAttachmentInfo)"> <summary> Returns the file from disk or (if not available on the disk) from database. </summary> <param name="attachmentInfo">Forum attachment info object</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetAttachmentFileBinary(System.Guid,System.String)"> <summary> Returns the file binary from disk. </summary> <param name="guid">Attachment guid</param> <param name="siteName">Attachment sitename</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetFileFolder(System.String,System.String)"> <summary> Returns physical path to the file folder (files folder path + subfolder). </summary> <param name="siteName">Site name</param> <param name="guid">File GUID</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetFilePhysicalPath(System.String,System.String,System.String)"> <summary> Returns physical path to the file. </summary> <param name="siteName">Site name</param> <param name="guid">File GUID</param> <param name="extension">File extension</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.EnsureAttachmentPhysicalFile(CMS.Forums.ForumAttachmentInfo,System.String)"> <summary> Ensures the attachment file in the file system and returns the path to the file. </summary> <param name="attachmentInfo">Attachment info</param> <param name="siteName">Attachment site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetFilesFolderPath(System.String)"> <summary> Returns physical path to folder with forum attachments files which are associated with the specified site. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.SaveAttachmentFileToDisk(System.String,System.String,System.String,System.String,CMS.Core.BinaryData,System.Boolean)"> <summary> Saves attachment file to the disk. </summary> <param name="siteName">Attachment site name</param> <param name="guid">File GUID</param> <param name="fileName">File name</param> <param name="fileExtension">File extension</param> <param name="fileData">File data (byte[] or Stream)</param> <param name="synchronization">Indicates if this function is called from "ProcessTask"</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetImageThumbnail(CMS.Forums.ForumAttachmentInfo,System.Int32,System.Int32,System.Int32)"> <summary> Returns image thumbnail (from the disk - if already exists, or create new one and save it to disk - if doesnt exist). </summary> <param name="attachmentInfo">Attachment info</param> <param name="width">Image width</param> <param name="height">Image height</param> <param name="maxSideSize">Maximum side size</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetImageThumbnailFile(System.Guid,System.String,System.Int32,System.Int32)"> <summary> Returns the image thumbnail from the disk. </summary> <param name="guid">Guid of the file to get</param> <param name="siteName">Attachment sitename</param> <param name="height">Image thumbnail width</param> <param name="width">Image thumbnail height</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.EnsureThumbnailFile(CMS.Forums.ForumAttachmentInfo,System.Int32,System.Int32,System.Int32)"> <summary> Ensures the thumbnail. </summary> <param name="attachmentInfo">Attachment info</param> <param name="width">File width</param> <param name="height">File height</param> <param name="maxSideSize">Maximum side size</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.CanResizeImage(CMS.Forums.ForumAttachmentInfo,System.Int32,System.Int32,System.Int32)"> <summary> Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller). </summary> <param name="fileInfo">File info to check</param> <param name="width">New width</param> <param name="height">New height</param> <param name="maxSideSize">Max side size</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GenerateThumbnails(System.String)"> <summary> Returns the current settings whether the thumbnails should be generated. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentInfoInternal(System.Guid,System.String)"> <summary> Returns the ForumAttachment structure for the specified forumAttachment. </summary> <param name="guid">Forum attachment guid</param> <param name="siteName">Attachemnt site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentInfoWithoutBinaryInternal(System.Guid,System.String)"> <summary> Returns the ForumAttachment structure for the specified forumAttachment. </summary> <param name="guid">GUID of the forumAttachment to return</param> <param name="siteName">Attachment site name</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.SetInfo(CMS.Forums.ForumAttachmentInfo)"> <summary> Inserts or Updates the object to the database. </summary> <param name="info">Object to insert / update</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.DeleteInfo(CMS.Forums.ForumAttachmentInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentsInternal(System.Int32,System.Boolean)"> <summary> Returns DataSet with attachment which have relation to specified forum post id. </summary> <param name="postId">Forum post id</param> <param name="getBinary">If true binary data will be retrieved from DB</param> </member> <member name="M:CMS.Forums.ForumAttachmentInfoProvider.GetForumAttachmentsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset with attachments with dependence on input parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Top N</param> <param name="columns">Columns</param> </member> <member name="T:CMS.Forums.ForumsModule"> <summary> Represents the Forums module. </summary> </member> <member name="F:CMS.Forums.ForumsModule.FORUM_EMAIL_TEMPLATE_TYPE_NAME"> <summary> Name of email template type for forum. </summary> </member> <member name="F:CMS.Forums.ForumsModule.FORUM_SUBSCRIPTION_EMAIL_TEMPLATE_TYPE_NAME"> <summary> Name of email template type for forum subscription. </summary> </member> <member name="M:CMS.Forums.ForumsModule.#ctor"> <summary> Default constructor </summary> </member> <member name="M:CMS.Forums.ForumsModule.OnInit"> <summary> Initializes the module </summary> </member> <member name="M:CMS.Forums.ForumsModule.InitImportExport"> <summary> Initializes Import/Export handlers </summary> </member> <member name="M:CMS.Forums.ForumsModule.InitMacros"> <summary> Initializes the macro engine from the module </summary> </member> <member name="M:CMS.Forums.ForumsModule.RegisterCommands"> <summary> Registers the object type of this module </summary> </member> <member name="M:CMS.Forums.ForumsModule.GetDocumentForumsCount(System.Object[])"> <summary> Get number of forums for selected document </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.AddForumModerator(System.Object[])"> <summary> Adds the moderator to the forum </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.RemoveForumModerator(System.Object[])"> <summary> Remove the moderator from the forum </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.GetForumInfo(System.Object[])"> <summary> Returns forum info by forum id </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.GetForumPostInfo(System.Object[])"> <summary> Returns forum post info by forum post id </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.GetForumGroupInfo(System.Object[])"> <summary> Returns forum group info by forum group id </summary> <param name="parameters">Parameters array</param> </member> <member name="M:CMS.Forums.ForumsModule.GetForumPostUrl(System.Object[])"> <summary> Returns post URL </summary> <param name="parameters">Parameters array</param> </member> <member name="T:CMS.Forums.ForumGroupInfo"> <summary> ForumGroupInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumGroupInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumGroupInfo.OBJECT_TYPE_GROUP"> <summary> Object type for group </summary> </member> <member name="F:CMS.Forums.ForumGroupInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.Forums.ForumGroupInfo.TYPEINFOGROUP"> <summary> Type information for group forum group. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupAttachmentMaxFileSize"> <summary> Gets or sets the max file size for forum attachment, 0 = unlimited. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupRequireEmail"> <summary> Gets or sets the value which determines whether the user has to enter e-mail when inserting new post. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupDisplayEmails"> <summary> Gets or sets the value which determines whether the user e-mail is displayed in Group post. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupUseCAPTCHA"> <summary> Gets or sets the value which determines whether the group forums use CAPTCHA for new posts. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupHTMLEditor"> <summary> Gets or sets the value which determines whether the group forums use HTML editor to edit posts. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupAuthorEdit"> <summary> Gets or sets the value which determines whether the author of the post can edit his own posts. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupAuthorDelete"> <summary> Gets or sets the value which determines whether the author of the post can delete his own posts. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupType"> <summary> Gets or sets the type of the forum. 0 = User can choose whether post is question 1 = Discussion forum (default) 2 = Answer forum </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupIsAnswerLimit"> <summary> Gets or sets the limit of the votes to mark the post as an answer. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupImageMaxSideSize"> <summary> Gets or sets the maximal allowed side size of the image (larger images are resized to this size). </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.InheritedBaseUrl"> <summary> Returns inherited base URL from settings. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupBaseUrl"> <summary> Forum group base URL. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.InheritedUnsubscriptionUrl"> <summary> Returns inherited unsubscription URL from settings. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupUnsubscriptionUrl"> <summary> Forum group unsubscription URL. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupDescription"> <summary> Group description. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupSiteID"> <summary> Group site ID. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupOrder"> <summary> Group ordinal number. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupDisplayName"> <summary> Group display name. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupName"> <summary> Group name. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupID"> <summary> Group ID. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupGUID"> <summary> Group GUID. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupGroupID"> <summary> Community group id. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupLogActivity"> <summary> Log activity. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.InheritedEnableOptIn"> <summary> Returns inherited value indicating if the forum group should use double opt-in from settings. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableOptIn"> <summary> Gets or sets whether the forum group should use double opt-in. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.InheritedSendOptInConfirmation"> <summary> Returns inherited value indicating whether subscription confirmation should be sent after double opt-in e-mail from settings. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupSendOptInConfirmation"> <summary> Gets or sets whether subscription confirmation should be sent after double opt-in e-mail. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.InheritedOptInApprovalURL"> <summary> Returns inherited URL of the double opt-in page from settings. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupOptInApprovalURL"> <summary> Gets or sets the URL of the double opt-in page. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableURL"> <summary> Gets or sets the value which determines whether the forum users will be able to insert URL macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableAdvancedURL"> <summary> Gets or sets the value which determines whether the forum users will be able to insert URL macros into the post text using the advanced dialog. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableQuote"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Quote macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableImage"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableAdvancedImage"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text using the advanced dialog. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableFontBold"> <summary> Gets or sets the value which determines whether the forum users will be able to insert bold font macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableFontItalics"> <summary> Gets or sets the value which determines whether the forum users will be able to insert italics font macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableFontUnderline"> <summary> Gets or sets the value which determines whether the forum users will be able to insert underline font macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableFontStrike"> <summary> Gets or sets the value which determines whether the forum users will be able to insert strike font macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableCodeSnippet"> <summary> Gets or sets the value which determines whether the forum users will be able to insert code snippet macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.GroupEnableFontColor"> <summary> Gets or sets the value which determines whether the forum users will be able to insert font color macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumGroupInfo.TypeInfo"> <summary> Type information. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.CheckUniqueCodeName"> <summary> Checks if the object has unique code name. Returns true if the object has unique code name. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.#ctor"> <summary> Constructor - Creates an empty ForumGroupInfo object. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumGroupInfo object from the given DataRow. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Custom permissions check. Chat user can be read with Read or GlobalRead permission and modified with Modify or GlobalModify permission. </summary> <param name="permission">Permission to perform this operation will be checked</param> <param name="siteName">Permissions on this site will be checked</param> <param name="userInfo">Permissions of this user will be checked</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> <returns>True if user is allowed to perform specified operation on the this object; otherwise false</returns> </member> <member name="T:CMS.Forums.ForumGroupInfoProvider"> <summary> Class providing ForumGroupInfo management. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetForumGroups"> <summary> Returns a query for all the ForumGroupInfo objects. </summary> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetGroups(System.String,System.String)"> <summary> Returns records on groups according to the specified conditions. </summary> <param name="where">Where condition to apply</param> <param name="orderBy">Order by statement used to sort the data</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetGroups(System.String,System.String,System.Int32,System.String)"> <summary> Returns records on groups according to the specified conditions. </summary> <param name="where">Where condition to apply</param> <param name="orderBy">Order by statement used to sort the data</param> <param name="topN">TOP N Rows</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetForumGroupInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetForumGroupInfo(System.Int32)"> <summary> Returns the ForumGroupInfo structure for the specified forumGroup. </summary> <param name="forumGroupId">ForumGroup id</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetAdHocGroupInfo(System.Int32)"> <summary> Returns or create AdHoc group info. </summary> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetForumGroupInfo(System.String,System.Int32,System.Int32)"> <summary> Returns the ForumGroupInfo structure for the specified forumGroup. </summary> <param name="forumGroupName">ForumGroup name</param> <param name="siteId">Site id</param> <param name="communityGroupId">Community group id</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetForumGroupInfo(System.String,System.Int32)"> <summary> Returns the ForumGroupInfo structure for the specified forumGroup. </summary> <param name="forumGroupName">ForumGroup name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.SetForumGroupInfo(CMS.Forums.ForumGroupInfo)"> <summary> Sets (updates or inserts) specified forumGroup. </summary> <param name="forumGroup">ForumGroup to set</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.DeleteForumGroupInfo(CMS.Forums.ForumGroupInfo)"> <summary> Deletes specified forumGroup. </summary> <param name="forumGroupObj">ForumGroup object</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.DeleteForumGroupInfo(System.Int32)"> <summary> Deletes specified forumGroup. </summary> <param name="forumGroupId">ForumGroup id</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.MoveGroupUp(System.Int32)"> <summary> Moves group up in the order sequence (up = smaller GroupOrder = sooner in the navigation). </summary> <param name="forumGroupId">Group ID to move</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.MoveGroupDown(System.Int32)"> <summary> Moves group down in the order sequence (down = larger GroupOrder = later in the navigation). </summary> <param name="forumGroupId">Group ID to move</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.DoubleOptInInterval(System.String)"> <summary> Gets double opt-in interval for the site. It's time interval in hours within which user has to approve her subscription. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.SendOptInConfirmation(System.String)"> <summary> Gets setting value indicating if double opt-in confirmation emails should be sent </summary> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.EnableDoubleOptIn(System.String)"> <summary> Gets setting value indicating if double opt-in should be enabled </summary> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.GetGroupsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns records on groups according to the specified conditions. </summary> <param name="where">Where condition to apply</param> <param name="orderBy">Order by statement used to sort the data</param> <param name="topN">TOP N Rows</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.SetInfo(CMS.Forums.ForumGroupInfo)"> <summary> Inserts or Updates the object to the database. </summary> <param name="info">Object to insert / update</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.DeleteInfo(CMS.Forums.ForumGroupInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.MoveGroupUpInternal(System.Int32)"> <summary> Moves group up in the order sequence (up = smaller GroupOrder = sooner in the navigation). </summary> <param name="forumGroupId">Group ID to move</param> </member> <member name="M:CMS.Forums.ForumGroupInfoProvider.MoveGroupDownInternal(System.Int32)"> <summary> Moves group down in the order sequence (down = larger GroupOrder = later in the navigation). </summary> <param name="forumGroupId">Group ID to move</param> </member> <member name="T:CMS.Forums.ForumInfo"> <summary> ForumInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumInfo.OBJECT_TYPE_GROUP"> <summary> Object type for group </summary> </member> <member name="F:CMS.Forums.ForumInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="F:CMS.Forums.ForumInfo.TYPEINFOGROUP"> <summary> Type information for group forum. </summary> </member> <member name="P:CMS.Forums.ForumInfo.CurrentForumGroupInfo"> <summary> Gets ForumGroupInfo for this forum. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumAttachmentMaxFileSize"> <summary> Gets or sets the max file size for forum attachment, 0 = unlimited. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumSettings"> <summary> Forum settings. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumAuthorEdit"> <summary> Gets or sets the value which determines whether the author of the post can edit his own posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumAuthorDelete"> <summary> Gets or sets the value which determines whether the author of the post can delete his own posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumType"> <summary> Gets or sets the type of the forum. 0 = User can choose whether post is question 1 = Discussion forum (default) 2 = Answer forum </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumIsAnswerLimit"> <summary> Gets or sets the limit of the votes to mark the post as an answer. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumImageMaxSideSize"> <summary> Gets or sets the maximal allowed side size of the image (larger images are resized to this size). </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumIsLocked"> <summary> Gets or sets the value that indicates whether forum is locked. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumUseCAPTCHA"> <summary> Forum use CAPTCHA for new post. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumHTMLEditor"> <summary> Forum use HTML editor to edit posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumAllowChangeName"> <summary> Forum allow user to change the name. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumOpen"> <summary> Indicates whether forum is open (users can add posts). </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumBaseUrl"> <summary> Forum base URL. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumUnsubscriptionUrl"> <summary> Forum base URL. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumDocumentID"> <summary> Forum document ID. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumSiteID"> <summary> Forum site ID. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumDisplayEmails"> <summary> Indicates whether emails of users in posts are displayed. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumDescription"> <summary> Forum description. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLastPostUserName"> <summary> Last post user name. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumPosts"> <summary> Number of posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumRequireEmail"> <summary> Indicates whether forum requires email. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumDisplayName"> <summary> Display name. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumName"> <summary> Forum name (code name). </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumOrder"> <summary> Forum ordinal number. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumThreads"> <summary> Number of threads. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumGroupID"> <summary> Forum group ID. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumAccess"> <summary> Forum access bit array. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowAccess"> <summary> Indicates whether the access to forum is allowed. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowAttachFiles"> <summary> Indicates whether the files could be attached to the forum post. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowSubscribe"> <summary> Indicates whether the subscribing to the forum post is allowed. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowMarkAsAnswer"> <summary> Indicates whether the quoting of the forum post is allowed. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowReply"> <summary> Indicates whether the replies are allowed for the forum posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.AllowPost"> <summary> Indicates whether the posts are allowed for the forum. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumID"> <summary> Forum ID. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLastPostTime"> <summary> Last post time. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumModerated"> <summary> Indicates whether forum is moderated. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumGUID"> <summary> Forum GUID. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumThreadsAbsolute"> <summary> Number of all threads. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumPostsAbsolute"> <summary> Number of all posts. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLastPostUserNameAbsolute"> <summary> User name of last post. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLastPostTimeAbsolute"> <summary> Object last modified. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumLogActivity"> <summary> Indicates whether forum actions are logged as on-line marketing activities. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumCommunityGroupID"> <summary> Forum community group ID </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableOptIn"> <summary> Gets or sets whether the forum should use double opt-in. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumSendOptInConfirmation"> <summary> Gets or sets whether subscription confirmation should be sent after double opt-in e-mail. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumOptInApprovalURL"> <summary> Gets or sets the URL of the double opt-in page. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableURL"> <summary> Gets or sets the value which determines whether the forum users will be able to insert URL macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableAdvancedURL"> <summary> Gets or sets the value which determines whether the forum users will be able to insert URL macros into the post text using the advanced dialogs. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableQuote"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Quote macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableImage"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableAdvancedImage"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text using the advanced dialogs. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableCodeSnippet"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableFontBold"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableFontItalics"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableFontUnderline"> <summary> Gets or sets the value which determines whether the forum users will be able to insert Image macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableFontStrike"> <summary> Gets or sets the value which determines whether the forum users will be able to insert font strike macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.ForumEnableFontColor"> <summary> Gets or sets the value which determines whether the forum users will be able to insert font color macros into the post text. </summary> </member> <member name="P:CMS.Forums.ForumInfo.TypeInfo"> <summary> Type information. </summary> </member> <member name="M:CMS.Forums.ForumInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumInfo.RegisterProperties"> <summary> Registers the properties of this object </summary> </member> <member name="M:CMS.Forums.ForumInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </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="M:CMS.Forums.ForumInfo.InsertAsClonePostprocessing(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Clones forum role and forum moderator bindings </summary> <param name="settings">Cloning settings</param> <param name="result">Result of the cloning - messages in this object will be altered by processing this method</param> <param name="originalObject">Original source BaseInfo (object being cloned)</param> </member> <member name="M:CMS.Forums.ForumInfo.CheckLicense(CMS.DataEngine.ObjectActionEnum,System.String)"> <summary> Checks the object license. Returns true if the licensing conditions for this object were matched </summary> <param name="action">Object action</param> <param name="domainName">Domain name, if not set, uses current domain</param> </member> <member name="M:CMS.Forums.ForumInfo.#ctor"> <summary> Constructor - Creates an empty ForumInfo object. </summary> </member> <member name="M:CMS.Forums.ForumInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumInfo object from the given DataRow. </summary> </member> <member name="M:CMS.Forums.ForumInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Custom permissions check. Chat user can be read with Read or GlobalRead permission and modified with Modify or GlobalModify permission. </summary> <param name="permission">Permission to perform this operation will be checked</param> <param name="siteName">Permissions on this site will be checked</param> <param name="userInfo">Permissions of this user will be checked</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> <returns>True if user is allowed to perform specified operation on the this object; otherwise false</returns> </member> <member name="T:CMS.Forums.ForumInfoProvider"> <summary> Class providing ForumInfo management. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForums"> <summary> Returns a query for all the ForumInfo objects. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumsCount(System.Int32)"> <summary> Returns the number of message boards related to the specified document. </summary> <param name="documentId">Document ID to return number of boards for</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfo(System.Int32)"> <summary> Returns the ForumInfo structure for the specified forum. </summary> <param name="forumId">Forum id</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfo(System.String,System.Int32)"> <summary> Returns the ForumInfo structure for the specified forum. </summary> <param name="forumName">Forum name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfo(System.String,System.Int32,System.Int32)"> <summary> Returns the ForumInfo structure for the specified forum. </summary> <param name="forumName">Forum name</param> <param name="siteId">Site ID</param> <param name="groupId">Community group ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfoByDocument(System.Int32)"> <summary> Returns the ForumInfo structure for the specified document. </summary> <param name="documentId">Document ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.SetForumInfo(CMS.Forums.ForumInfo)"> <summary> Sets (updates or inserts) specified forum. </summary> <param name="forum">Forum to set</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.DeleteForumInfo(CMS.Forums.ForumInfo)"> <summary> Deletes specified forum. </summary> <param name="forumObj">Forum object</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.DeleteForumInfo(System.Int32)"> <summary> Deletes specified forum. </summary> <param name="forumId">Forum id</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.MoveForumUp(System.Int32)"> <summary> Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation). </summary> <param name="forumId">Forum ID to move</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.MoveForumDown(System.Int32)"> <summary> Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation). </summary> <param name="forumId">Forum ID to move</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumsByGroupID(System.Int32,System.Boolean)"> <summary> Returns DataSet with all forums which are assigned to group id. </summary> <param name="groupId">Forum group ID</param> <param name="onlyOpen">Get only open forums or all</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumsByGroupID(System.Int32)"> <summary> Returns DataSet with all forums which are assigned to group id. </summary> <param name="groupId">Forum group ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetRoleNamesForForum(System.Int32)"> <summary> Returns RoleNames in format rolename1;rolename2;rolename3.... </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.UpdateForumCounts(System.Int32)"> <summary> Update threads, posts, last user and last time values. </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.UpdateQuestionSolved(System.Int32,System.String)"> <summary> Updates PostQuestionSolved field in threads. Sets true in threads where at least one post is marked as is answer (according to the forum AnswerLimit settings). </summary> <param name="forumId">Forum ID</param> <param name="postIdPath">Post id path</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetAllForums(System.String,System.String)"> <summary> Returns all forums according to the specified conditions. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetAllForums"> <summary> Returns all forums. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForums(System.String,System.String,System.Int32,System.String)"> <summary> Returns forums according to the specified conditions. </summary> <param name="where">Where condition to apply</param> <param name="orderBy">Order by statement used to sort the data</param> <param name="topN">TOP N Rows</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.AddRoleToForum(System.Int32,System.Int32,System.Int32)"> <summary> Adds specified role to the forum. </summary> <param name="roleId">Role ID</param> <param name="forumId">Forum ID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.RemoveRoleFromForum(System.Int32,System.Int32,System.Int32)"> <summary> Removes the forum role assignment. </summary> <param name="roleId">Role ID</param> <param name="forumId">Forum ID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.IsRoleAllowedForForum(System.Int32,System.Int32)"> <summary> Returns true if role is allowed for given forum. </summary> <param name="roleId">Role ID</param> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.AddModerator(System.Int32,System.Int32)"> <summary> Add moderator to forum, return moderator Id. </summary> <param name="userId">User ID</param> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.RemoveModerator(System.Int32,System.Int32)"> <summary> Remove moderator from forum id. </summary> <param name="userId">User ID</param> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetModerators(System.Int32)"> <summary> Returns DataSet with moderators(User) to specified forum. </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetModerator(System.Int32)"> <summary> Returns forum id's to moderator assigned by user id. </summary> <param name="userId">User ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.LicenseVersionCheck(System.String,CMS.DataEngine.FeatureEnum,CMS.DataEngine.ObjectActionEnum)"> <summary> License version check. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.ClearLicCheck"> <summary> Clear license limitations table. </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.CheckLicense(CMS.DataEngine.ObjectActionEnum,System.String)"> <summary> Checks the license. </summary> <param name="action">Object action</param> <param name="domainName">Domain name, if not set, current domain name is used</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.RefreshDataCount(System.String,System.Int32)"> <summary> Refresh threads and posts count. </summary> <param name="forumName">Forum name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.CombineSecurityWhereCondition(System.String,System.Int32)"> <summary> Add security where condition to the existing where condition. </summary> <param name="where">Existing where condition</param> <param name="communityGroupId">Community group ID</param> <returns>Returns where condition</returns> </member> <member name="M:CMS.Forums.ForumInfoProvider.IsAuthorizedPerForum(System.Int32,System.Int32,System.String,CMS.Helpers.SecurityAccessEnum,CMS.Membership.UserInfo)"> <summary> Indicates whether specified user has assigned specific permission for the specified forum. </summary> <param name="forumId">Forum id</param> <param name="forumGroupId">ID of the Forum group of the forum</param> <param name="permissionName">Name of the permission to check</param> <param name="permissionScope">Permission to check</param> <param name="user">User info</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumSiteName(System.Int32)"> <summary> Returns site name with dependence on selected forum id. </summary> <param name="forumId">Forum Id</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumIdsByForumName(System.String,System.Int32)"> <summary> Returns IDs of forums with specified name. </summary> <param name="name">Forum name, may contain wildcard e.g. "MyForum_*"</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetSearchDocuments(CMS.Search.SearchIndexInfo,CMS.DataEngine.WhereCondition,System.Int32)"> <summary> Returns search documents </summary> <param name="sii">Search index info</param> <param name="where">Where condition for the documents</param> <param name="lastId">Last post ID that was processed</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.UpdateData(System.String,System.String,CMS.DataEngine.QueryDataParameters)"> <summary> Updates data for all records given by where condition </summary> <param name="updateExpression">Update expression, e.g. "Value = Value * 2"</param> <param name="where">Where condition</param> <param name="parameters">Parameters</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumsCountInternal(System.Int32)"> <summary> Returns the number of message boards related to the specified document. </summary> <param name="documentId">Document ID to return number of boards for</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumInfoByDocumentInternal(System.Int32)"> <summary> Returns the ForumInfo structure for the specified document. </summary> <param name="documentId">Document ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.SetInfo(CMS.Forums.ForumInfo)"> <summary> Inserts or Updates the object to the database. </summary> <param name="info">Object to insert / update</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.DeleteInfo(CMS.Forums.ForumInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.DeleteAttachments(CMS.Forums.ForumInfo)"> <summary> Delete attachments related to the current forum </summary> </member> <member name="M:CMS.Forums.ForumInfoProvider.MoveForumUpInternal(System.Int32)"> <summary> Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation). </summary> <param name="forumId">Forum ID to move</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.MoveForumDownInternal(System.Int32)"> <summary> Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation). </summary> <param name="forumId">Forum ID to move</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetRoleNamesForForumInternal(System.Int32)"> <summary> Returns RoleNames in format rolename1;rolename2;rolename3.... </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.UpdateForumCountsInternal(System.Int32)"> <summary> Update threads, posts, last user and last time values. </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.UpdateQuestionSolvedInternal(System.Int32,System.String)"> <summary> Updates PostQuestionSolved field in threads. Sets true in threads where at least one post is marked as is answer (according to the forum AnswerLimit settings). </summary> <param name="forumId">Forum ID</param> <param name="postIdPath">Post id path</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetForumsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns forums according to the specified conditions. </summary> <param name="where">Where condition to apply</param> <param name="orderBy">Order by statement used to sort the data</param> <param name="topN">TOP N Rows</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.IsRoleAllowedForForumInternal(System.Int32,System.Int32)"> <summary> Returns true if role is allowed for given forum. </summary> <param name="roleId">Role ID</param> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetModeratorsInternal(System.Int32)"> <summary> Returns DataSet with moderators(User) to specified forum. </summary> <param name="forumId">Forum ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.GetModeratorInternal(System.Int32)"> <summary> Returns forum id's to moderator assigned by user id. </summary> <param name="userId">User ID</param> </member> <member name="M:CMS.Forums.ForumInfoProvider.CombineSecurityWhereConditionInternal(System.String,System.Int32)"> <summary> Add security where condition to the existing where condition. </summary> <param name="where">Existing where condition</param> <param name="communityGroupId">Community group ID</param> <returns>Returns where condition</returns> </member> <member name="M:CMS.Forums.ForumInfoProvider.IsAuthorizedPerForumInternal(System.Int32,System.Int32,System.String,CMS.Helpers.SecurityAccessEnum,CMS.Membership.UserInfo)"> <summary> Indicates whether specified user has assigned specific permission for the specified forum. </summary> <param name="forumId">ID of the forum to check permission for</param> <param name="forumGroupId">ID of the group to check permission for</param> <param name="permissionName">Name of the permission</param> <param name="permissionScope">User level</param> <param name="user">User info to check permission for</param> <returns></returns> </member> <member name="M:CMS.Forums.ForumInfoProvider.IsUserAuthorizedPerForum(System.Int32,System.String,CMS.Membership.UserInfo,System.Int32)"> <summary> Indicates whether specified user has assigned specific permission for the specified forum. </summary> <param name="forumId">ID of the forum to check permission for</param> <param name="permissionName">Name of the permission</param> <param name="userInfo">User info to check permission for</param> <param name="siteId">ID of the site role should belongs to</param> </member> <member name="T:CMS.Forums.ForumModeratorInfo"> <summary> Forum moderator binding. </summary> </member> <member name="F:CMS.Forums.ForumModeratorInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumModeratorInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Forums.ForumModeratorInfo.UserID"> <summary> User ID. </summary> </member> <member name="P:CMS.Forums.ForumModeratorInfo.ForumID"> <summary> Forum ID. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfo.#ctor"> <summary> Constructor - Creates an empty ForumRoleInfo object. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumRoleInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Forums.ForumModeratorInfoProvider"> <summary> Class providing ForumModeratorInfo management. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.GetUserModeratedForums(System.Int32)"> <summary> Returns forums ids in which is user moderator. </summary> <param name="userId">User ID</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.GetGroupForumsModerators(System.Int32)"> <summary> Returns dataset with forum moderators. </summary> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.GetGroupForumsModerators(System.String,System.String)"> <summary> Returns dataset with forum moderators. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.GetForumModeratorInfo(System.Int32,System.Int32)"> <summary> Returns the ForumModeratorInfo structure for the specified forumModerator. </summary> <param name="userId">UserID</param> <param name="forumId">ForumID</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.SetForumModeratorInfo(CMS.Forums.ForumModeratorInfo)"> <summary> Sets (updates or inserts) specified forumModerator. </summary> <param name="forumModerator">ForumModerator to set</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.DeleteForumModeratorInfo(CMS.Forums.ForumModeratorInfo)"> <summary> Deletes specified forumModerator. </summary> <param name="infoObj">ForumModerator object</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.RemoveModeratorFromForum(System.Int32,System.Int32)"> <summary> Deletes specified forumModerator. </summary> <param name="userId">UserID</param> <param name="forumId">ForumID</param> </member> <member name="M:CMS.Forums.ForumModeratorInfoProvider.AddModeratorToForum(System.Int32,System.Int32)"> <summary> Add moderator to forum, return moderator Id. </summary> <param name="userId">User ID</param> <param name="forumId">Forum ID</param> </member> <member name="T:CMS.Forums.ForumRoleInfo"> <summary> ForumRoleInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumRoleInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumRoleInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Forums.ForumRoleInfo.RoleID"> <summary> Role ID. </summary> </member> <member name="P:CMS.Forums.ForumRoleInfo.ForumID"> <summary> Forum ID. </summary> </member> <member name="P:CMS.Forums.ForumRoleInfo.PermissionID"> <summary> Permission ID. </summary> </member> <member name="M:CMS.Forums.ForumRoleInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumRoleInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumRoleInfo.#ctor"> <summary> Constructor - Creates an empty ForumRoleInfo object. </summary> </member> <member name="M:CMS.Forums.ForumRoleInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumRoleInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Forums.ForumRoleInfoProvider"> <summary> Class providing ForumRoleInfo management. </summary> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.GetForumRoleInfo(System.Int32,System.Int32,System.Int32)"> <summary> Returns the ForumRoleInfo structure for the specified forumRole. </summary> <param name="roleId">RoleID</param> <param name="forumId">ForumID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.SetForumRoleInfo(CMS.Forums.ForumRoleInfo)"> <summary> Sets (updates or inserts) specified forumRole. </summary> <param name="forumRole">ForumRole to set</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.DeleteForumRoleInfo(CMS.Forums.ForumRoleInfo)"> <summary> Deletes specified forumRole. </summary> <param name="infoObj">ForumRole object</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.RemoveRoleFromForum(System.Int32,System.Int32,System.Int32)"> <summary> Deletes specified forumRole. </summary> <param name="roleId">RoleID</param> <param name="forumId">ForumID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.AddRoleToForum(System.Int32,System.Int32,System.Int32)"> <summary> Adds specified role to the forum. </summary> <param name="roleId">RoleID</param> <param name="forumId">ForumID</param> <param name="permissionId">Permission ID</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.GetPermissionMatrix(System.Int32,System.Int32,System.Int32,System.Int32)"> <summary> Returns the permission matrix for the specified forum. </summary> <param name="resourceId">ID of the resource matrix is returned for</param> <param name="siteId">Site ID</param> <param name="roleGroupId">ID of the group roles should belongs to</param> <param name="forumId">ID of the forum permission matrix is retrieved for</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.DeleteAllRoles(CMS.DataEngine.IWhereCondition)"> <summary> Delete all forum roles. </summary> <param name="where">Where condition</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.SetPermissions(System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Sets permissions for list of roles. </summary> <param name="forumId">Forum ID</param> <param name="roleIds">List of role IDs</param> <param name="permissionsIds">List of permission IDs</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.GetRelationships(System.String,System.String,System.Int32,System.String)"> <summary> Returns the relationships specified by the parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.SetPermissionsInternal(System.Int32,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Sets permissions for list of roles. </summary> <param name="forumId">Forum ID</param> <param name="roleIds">List of role IDs</param> <param name="permissionsIds">List of permission IDs</param> </member> <member name="M:CMS.Forums.ForumRoleInfoProvider.CreateForumRole(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Creates collection of forum role objects with specific permissions. </summary> <param name="forumId">Forum ID</param> <param name="roleId">Role ID</param> <param name="permissionsIds">List of permission IDs</param> </member> <member name="T:CMS.Forums.ForumUserFavoritesInfo"> <summary> ForumUserFavoritesInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumUserFavoritesInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumUserFavoritesInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.SiteID"> <summary> Site ID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.UserID"> <summary> User ID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.FavoriteName"> <summary> Favorite name. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.PostID"> <summary> Post ID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.FavoriteID"> <summary> Favorite ID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.ForumID"> <summary> Forum ID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.FavoriteGUID"> <summary> Favorite GUID. </summary> </member> <member name="P:CMS.Forums.ForumUserFavoritesInfo.FavoriteLastModified"> <summary> Favorite last modified. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfo.GetCacheDependencies"> <summary> Gets collection of dependency keys to be touched when modifying the current object. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfo.#ctor"> <summary> Constructor - Creates an empty ForumUserFavoritesInfo object. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumUserFavoritesInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Forums.ForumUserFavoritesInfoProvider"> <summary> Class providing ForumUserFavoritesInfo management. </summary> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.GetForumUserFavoritesInfo(System.Int32)"> <summary> Returns the ForumUserFavoritesInfo structure for the specified forumUserFavorites. </summary> <param name="forumUserFavoritesId">ForumUserFavorites id</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.SetForumUserFavoritesInfo(CMS.Forums.ForumUserFavoritesInfo)"> <summary> Sets (updates or inserts) specified forumUserFavorites. </summary> <param name="forumUserFavorites">ForumUserFavorites to set</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.DeleteForumUserFavoritesInfo(CMS.Forums.ForumUserFavoritesInfo)"> <summary> Deletes specified forumUserFavorites. </summary> <param name="infoObj">ForumUserFavorites object</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.DeleteForumUserFavoritesInfo(System.Int32)"> <summary> Deletes specified forumUserFavorites. </summary> <param name="forumUserFavoritesId">ForumUserFavorites id</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.GetFavorites(System.Int32,System.Int32)"> <summary> Returns dataset with user's favorites. </summary> <param name="userID">User ID</param> <param name="siteId">Site ID, if 0 no site is considered</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.GetFavorites(System.String,System.String)"> <summary> Gets user-favorites dataset filtered by given WHERE condition and ordered by specified ORDER BY statement. </summary> <param name="where">Where condition to use</param> <param name="orderBy">Order by statement to use</param> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.AddUserFavoritePost(System.Int32,System.Int32,System.String,System.Int32)"> <summary> Adds post to user favorites (if the rercord does not exists yet). </summary> <param name="postId">ID of the favorite post</param> <param name="userId">ID of the user</param> <param name="favoriteName">Favorite name</param> <param name="siteId">Site id</param> <returns>Returns true if forum was added to favorites</returns> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.AddUserFavoriteForum(System.Int32,System.Int32,System.String,System.Int32)"> <summary> Adds forum to user favorites (if the rercord does not exists yet). </summary> <param name="forumId">ID of the favorite forum</param> <param name="userId">ID of the user</param> <param name="favoriteName">Favorite name</param> <param name="siteId">Site id</param> <returns>Returns true if forum was added to favorites</returns> </member> <member name="M:CMS.Forums.ForumUserFavoritesInfoProvider.UpdateData(System.String,System.String,CMS.DataEngine.QueryDataParameters)"> <summary> Updates data for all records given by where condition </summary> <param name="updateExpression">Update expression, e.g. "Value = Value * 2"</param> <param name="where">Where condition</param> <param name="parameters">Parameters</param> </member> <member name="T:CMS.Forums.ThreadEmailSender"> <summary> Sends forum e-mail messages in a separate thread. </summary> </member> <member name="M:CMS.Forums.ThreadEmailSender.#ctor(System.Int32,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:CMS.Forums.ThreadEmailSender"/> class. </summary> <param name="postId">The post ID</param> <param name="moderatorEmail">If set to <c>true</c>, email is sent to moderator</param> </member> <member name="M:CMS.Forums.ThreadEmailSender.#ctor(System.Int32,System.Boolean,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:CMS.Forums.ThreadEmailSender"/> class. </summary> <param name="postId">The post ID</param> <param name="moderatorEmail">If set to <c>true</c>, email is sent to moderator</param> <param name="baseUrl">Default base URL</param> <param name="unsubscriptionUrl">Default unsubscription URL</param> </member> <member name="M:CMS.Forums.ThreadEmailSender.Run"> <summary> Runs the thread. </summary> </member> <member name="T:CMS.Forums.ForumPostInfo"> <summary> ForumPostInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumPostInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumPostInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostInfo"> <summary> Post IP, and agent values. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.SiteId"> <summary> Gets or sets the SiteID of the post </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostType"> <summary> Gets or sets the type of the post (0=Normal, 1=Answer). </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostLastEdit"> <summary> Gets or sets the date of last edit. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostViews"> <summary> Gets or sets the value that indicates how many times thread was displayed. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostStickOrder"> <summary> Gets or sets the value that indicates whether the current post is sticked and in which order. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostIsAnswer"> <summary> Gets or sets the value that indicates how many users set this post answer. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostIsNotAnswer"> <summary> Gets or sets the value that indicates how many users set this post as not answer. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostQuestionSolved"> <summary> Indicates whether current thread (if it's question) is solved - i.e. there is at least one post marked as solution in the thread. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostIsLocked"> <summary> Indicates whether current post is locked. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostUserSignature"> <summary> Post user signature. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadPosts"> <summary> Number of thread posts. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadLastPostUserName"> <summary> Last post user name. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadLastPostTime"> <summary> Time of last post of thread. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostId"> <summary> Post ID. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostTime"> <summary> Post time. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostLevel"> <summary> Post level. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostUserMail"> <summary> User mail. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostForumID"> <summary> Post forum ID. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostText"> <summary> Post text. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostApprovedByUserID"> <summary> Approved by user ID. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostParentID"> <summary> Parent post ID. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostUserID"> <summary> User ID of user which added post. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostIDPath"> <summary> Post ID path - unique path (for tree purposes). </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostApproved"> <summary> Indicates whether current post is approved, approver is specified by PostApprovedByuserID property. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostSubject"> <summary> Post subject. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostUserName"> <summary> Post user name. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostGUID"> <summary> Post GUID. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostAttachmentCount"> <summary> Post attachment count. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadPostsAbsolute"> <summary> Number of all posts. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadLastPostUserNameAbsolute"> <summary> User name of last post. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.PostThreadLastPostTimeAbsolute"> <summary> Forum thread last modified time. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.GetValue(System.String)"> <summary> Gets the field value. </summary> <param name="columnName">Column name</param> </member> <member name="M:CMS.Forums.ForumPostInfo.GetSiblingsWhereCondition"> <summary> Creates where condition according to Parent, Group and Site settings. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.BuildObjectPath(System.String,System.String,System.String,System.String,System.Int32@)"> <summary> Builds the path from the given column. </summary> <param name="parentColumName">Column of the parent ID</param> <param name="pathColumnName">Column name to build the path from</param> <param name="levelColumnName">Column name of the level</param> <param name="level">Level of the object within the tree hierarchy</param> <param name="pathPartColumn">Name of the column which creates the path (IDColumn for IDPath, CodeNameColumn for name path)</param> </member> <member name="M:CMS.Forums.ForumPostInfo.Approve"> <summary> Approves this post by current user and immediately saves it to DB. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.Approve(System.Int32,System.Boolean)"> <summary> Approves this post by specified user id and optionally all its sub-posts. </summary> <param name="userId">The user id</param> <param name="withSubtree">If set to <c>true</c> all sub-posts of this post are approved too</param> </member> <member name="M:CMS.Forums.ForumPostInfo.Reject"> <summary> Rejects this post and immediately saves it to DB. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.Reject(System.Boolean)"> <summary> Rejects this post and optionally all its sub-posts. </summary> <param name="withSubtree">If set to <c>true</c> all sub-posts of this post are rejected too</param> </member> <member name="M:CMS.Forums.ForumPostInfo.InsertAsCloneInternal(CMS.DataEngine.CloneSettings,CMS.DataEngine.CloneResult,CMS.DataEngine.BaseInfo)"> <summary> Inserts cloned object to DB. </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="M:CMS.Forums.ForumPostInfo.RemoveObjectDependencies(System.Boolean,System.Boolean)"> <summary> Removes object dependencies. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.SetSiteIdFromForum"> <summary> Sets the post's siteID to the same SiteID as to post's forum. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.#ctor"> <summary> Constructor - Creates an empty ForumPostInfo object. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumPostInfo object from the given DataRow. </summary> </member> <member name="P:CMS.Forums.ForumPostInfo.SearchType"> <summary> Gets the type of current object. </summary> </member> <member name="M:CMS.Forums.ForumPostInfo.GetSearchFields(CMS.DataEngine.ISearchIndexInfo,CMS.DataEngine.ISearchFields)"> <summary> Returns search fields collection. When existing collection is passed as argument, fields will be added to that collection. When collection is not passed, new collection will be created and return. Collection will contain field values only when collection with StoreValues property set to true is passed to the method. When method creates new collection, it is created with StoreValues property set to false. </summary> <param name="index">Search index</param> <param name="searchFields">Search fields collection</param> </member> <member name="M:CMS.Forums.ForumPostInfo.GetSearchDocument(CMS.DataEngine.ISearchIndexInfo)"> <summary> Returns index document for current object. </summary> <param name="index">Search index info object</param> </member> <member name="T:CMS.Forums.ForumPostInfoProvider"> <summary> Class providing ForumPostInfo management. </summary> </member> <member name="P:CMS.Forums.ForumPostInfoProvider.ForumPostIdLength"> <summary> Post ID Path length. Default = 8 '00000001/000000001' </summary> </member> <member name="P:CMS.Forums.ForumPostInfoProvider.MaxPostLevel"> <summary> Returns maximal available post level. </summary> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetForumPostInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetForumPostInfo(System.Int32)"> <summary> Returns the ForumPostInfo structure for the specified forumPost. </summary> <param name="forumPostId">ForumPost id</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SetForumPostInfo(CMS.Forums.ForumPostInfo)"> <summary> Sets (updates or inserts) specified forumPost. </summary> <param name="forumPost">ForumPost to set</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SetForumPostInfo(CMS.Forums.ForumPostInfo,System.String,System.String)"> <summary> Sets (updates or inserts) specified forumPost. </summary> <param name="forumPost">ForumPost to set</param> <param name="baseUrl">Default base URL</param> <param name="unsubscriptionUrl">Default unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SetInfo(CMS.Forums.ForumPostInfo)"> <summary> Override to ensure SiteID is set </summary> <param name="info"></param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdateCounts(CMS.Forums.ForumPostInfo)"> <summary> Update thread and child-posts counts of specified post. </summary> <param name="postInfo">Forum post which thread and parent intended for recount</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdatePostCounts(System.Int32)"> <summary> Update direct-child-posts counts of specified post. </summary> <param name="postId">ID of the forum post to recount</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdateThreadCounts(System.String)"> <summary> Update thread sub-posts counts and last post information. </summary> <param name="path">Post path, first part determines the thread</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetPath(System.String,System.Int32)"> <summary> Returns PostIdPath in correct format. </summary> <param name="path">Posts path</param> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.DeleteForumPostInfo(CMS.Forums.ForumPostInfo)"> <summary> Deletes specified forumPost. </summary> <param name="forumPostObj">ForumPost object</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.DeleteForumPostInfo(System.Int32)"> <summary> Deletes specified forumPost. </summary> <param name="forumPostId">ForumPost id</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetForumPosts(System.String,System.String,System.Int32,System.String)"> <summary> Returns forum post DataSet. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select top n columns</param> <param name="columns">Columns which should be selected</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetForumPosts"> <summary> Gets all forum posts as object query </summary> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetCompleteWhere(System.Int32,System.String,System.String,System.Int32,System.Boolean)"> <summary> Creates complete where condition from parameters. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="where">Where condition</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String,System.Int32,System.Boolean,System.Int32)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> <param name="topN">Select TOP N posts</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String,System.Int32,System.Boolean,System.Int32,System.String)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> <param name="topN">Select TOP N posts</param> <param name="columns">List of columns which should be selected</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String,System.Int32,System.Boolean,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> <param name="topN">Select TOP N posts</param> <param name="columns">List of columns which should be selected</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 number of the records</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String,System.Int32,System.Boolean)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String,System.Int32)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String,System.String)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String,System.String)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.Int32,System.String)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPosts(System.String,System.String,System.Int32,System.String)"> <summary> Returns the DataSet of forum posts joined with user, user settings and other tables. </summary> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="topN">Select TOP N posts</param> <param name="columns">List of columns which should be selected</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.Search(System.String,System.String,System.Int32,System.String)"> <summary> Returns post, forum, forum group joined tables with dependence on. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by condition</param> <param name="topN">TOP N</param> <param name="columns">Columns to select</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetChildPosts(System.Int32)"> <summary> Returns all the child posts of the post. </summary> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SendPostEmails(System.Int32)"> <summary> Sends the new post acknowledgement to the users subscribed to the forum or forum thread where the post has been inserted. </summary> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SendPostEmails(System.Int32,System.String,System.String)"> <summary> Sends the new post acknowledgement to the users subscribed to the forum or forum thread where the post has been inserted. </summary> <param name="postId">Post ID</param> <param name="baseUrl">Default base URL</param> <param name="unsubscriptionUrl">Default unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SendModeratorsEmail(System.Int32)"> <summary> Send e-mail to moderators. </summary> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SendModeratorsEmail(System.Int32,System.String,System.String)"> <summary> Send e-mail to moderators. </summary> <param name="postId">Post ID</param> <param name="baseUrl">Default base URL</param> <param name="unsubscriptionUrl">Default unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.StickThread(CMS.Forums.ForumPostInfo)"> <summary> Stick thread. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UnstickThread(CMS.Forums.ForumPostInfo)"> <summary> Stick thread. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveStickyThreadUp(CMS.Forums.ForumPostInfo)"> <summary> Moves sticky thread up. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveStickyThreadDown(CMS.Forums.ForumPostInfo)"> <summary> Moves sticky thread down. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdatePostAttachmentCount(System.Int32)"> <summary> Counts number of attachments of post specified by postID and saves it into database. </summary> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.IncrementPostViews(System.Int32,System.Int32)"> <summary> Increments the post views with the specified number. </summary> <param name="postId">ID of the post the views of which are updated</param> <param name="viewCount">Number of views which will be added</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SplitThread(CMS.Forums.ForumPostInfo)"> <summary> Creates new thread from the given post. </summary> <param name="postInfo">Post to be separated from current thread</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveThread(CMS.Forums.ForumPostInfo,System.Int32)"> <summary> Moves the thread to other forum. </summary> <param name="postInfo">Post to be moved</param> <param name="forumId">ID of the forum where the post will be moved</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetPostRootFromIDPath(System.String)"> <summary> Returns root post ID for given PostIDPath. </summary> <param name="path">PostIDPath the root of which should be returned</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetPostURL(System.String,System.Int32,System.Boolean)"> <summary> Returns link to selected post. </summary> <param name="postIdPath">Post id path</param> <param name="forumId">Forum id</param> <param name="encodeQueryString">Indicates if query string should be encoded</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.FilterSearchResults(CMS.Search.ILuceneSearchDocument)"> <summary> Returns '0' if current user is authorized to view current search document. </summary> <param name="doc">Search document object</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.FilterSearchResults(CMS.Search.ILuceneSearchDocument,CMS.Membership.UserInfo)"> <summary> Returns '0' if specified user is authorized to view current search document. </summary> <param name="doc">Search document object</param> <param name="user">User info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetDocumentPosts(System.Int32)"> <summary> Returns forum posts for specified document </summary> <param name="documentId">Document ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdateData(System.String,System.String,CMS.DataEngine.QueryDataParameters)"> <summary> Updates data for all records given by where condition </summary> <param name="updateExpression">Update expression, e.g. "Value = Value * 2"</param> <param name="where">Where condition</param> <param name="parameters">Parameters</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SetForumPostInfoInternal(CMS.Forums.ForumPostInfo,System.String,System.String)"> <summary> Sets (updates or inserts) specified forumPost. </summary> <param name="forumPost">ForumPost to set</param> <param name="baseUrl">Default base URL</param> <param name="unsubscriptionUrl">Default unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdatePostCountsInternal(System.Int32)"> <summary> Update direct-child-posts counts of specified post. </summary> <param name="postId">ID of the forum post to recount</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdateThreadCountsInternal(System.String)"> <summary> Update thread sub-posts counts and last post information. </summary> <param name="path">Post path, first part determines the thread</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.DeleteForumPostInfoInternal(CMS.Forums.ForumPostInfo)"> <summary> Deletes specified forumPost. </summary> <param name="forumPostObj">ForumPost object</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetForumPostsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns forum post DataSet. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select top n columns</param> <param name="columns">Columns which should be selected</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPostsInternal(System.Int32,System.String,System.String,System.String,System.Int32,System.Boolean,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Returns the DataSet of forum posts in specified subtree of forum posts. </summary> <param name="forumId">Forum ID</param> <param name="path">Posts path</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="maxRelativeLevel">Maximal relative level</param> <param name="selectOnlyApproved">Select only approved posts</param> <param name="topN">Select TOP N posts</param> <param name="columns">List of columns which should be selected</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 number of the records</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SelectForumPostsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns the DataSet of forum posts joined with user, user settings and other tables. </summary> <param name="whereCondition">Where condition</param> <param name="orderBy">Order specification</param> <param name="topN">Select TOP N posts</param> <param name="columns">List of columns which should be selected</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SearchInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns post, forum, forum group joined tables with dependence on. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by condition</param> <param name="topN">TOP N</param> <param name="columns">Columns to select</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.GetChildPostsInternal(System.Int32)"> <summary> Returns all the child posts of the post. </summary> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.StickThreadInternal(CMS.Forums.ForumPostInfo)"> <summary> Stick thread. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UnstickThreadInternal(CMS.Forums.ForumPostInfo)"> <summary> Stick thread. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveStickyThreadUpInternal(CMS.Forums.ForumPostInfo)"> <summary> Moves sticky thread up. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveStickyThreadDownInternal(CMS.Forums.ForumPostInfo)"> <summary> Moves sticky thread down. </summary> <param name="fpi">Forum post info</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.UpdatePostAttachmentCountInternal(System.Int32)"> <summary> Counts number of attachments of post specified by postID and saves it into database. </summary> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.IncrementPostViewsInternal(System.Int32,System.Int32)"> <summary> Increments the post views with the specified number. </summary> <param name="postId">ID of the post the views of which are updated</param> <param name="viewCount">Number of views which will be added</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.SplitThreadInternal(CMS.Forums.ForumPostInfo)"> <summary> Creates new thread from the given post. </summary> <param name="postInfo">Post to be separated from current thread</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.MoveThreadInternal(CMS.Forums.ForumPostInfo,System.Int32)"> <summary> Moves the thread to other forum. </summary> <param name="postInfo">Post to be moved</param> <param name="forumId">ID of the forum where the post will be moved</param> </member> <member name="M:CMS.Forums.ForumPostInfoProvider.EnsureContinuousIntegrationReserialization(System.Data.DataSet)"> <summary> Handles the necessary continuous integration actions after a bulk update action. </summary> <param name="queryResult"></param> </member> <member name="T:CMS.Forums.ForumSubscriptionInfo"> <summary> ForumSubscriptionInfo data container class. </summary> </member> <member name="F:CMS.Forums.ForumSubscriptionInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Forums.ForumSubscriptionInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionEmail"> <summary> Subscription email. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionPostID"> <summary> Subscription post ID. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionGUID"> <summary> Subscription GUID. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionID"> <summary> Subscription ID. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionForumID"> <summary> Forum ID. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionUserID"> <summary> User ID of subscription. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionLastModified"> <summary> Object last modified. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionApproved"> <summary> Indicates if subscription approved. </summary> </member> <member name="P:CMS.Forums.ForumSubscriptionInfo.SubscriptionApprovalHash"> <summary> Subscription approval hash code. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionInfo.#ctor"> <summary> Constructor - Creates an empty ForumSubscriptionInfo object. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ForumSubscriptionInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Forums.ForumSubscriptionInfoProvider"> <summary> Class providing ForumSubscriptionInfo management. </summary> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetForumSubscriptionInfo(System.Int32)"> <summary> Returns the ForumSubscriptionInfo structure for the specified forumSubscription. </summary> <param name="forumSubscriptionId">ForumSubscription id</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetForumSubscriptionInfoByGUID(System.Guid)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetForumSubscriptionInfo(System.Guid)"> <summary> Returns the ForumSubscriptionInfo structure for the specified forumSubscritpionGuid. </summary> <param name="forumSubscritpionGuid">ForumSubscription GUID</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetForumSubscriptionInfo(System.String)"> <summary> Returns the ForumSubscriptionInfo structure for the specified forum subscription hash code. </summary> <param name="subscriptionHash">Subscription hash.</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetSubscriptions(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset with subscription with dependence on input conditions. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by condition</param> <param name="topN">TOP N</param> <param name="columns">Columns</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.SetForumSubscriptionInfo(CMS.Forums.ForumSubscriptionInfo)"> <summary> Sets (updates or inserts) specified forumSubscription. </summary> <param name="forumSubscription">ForumSubscription to set</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.SetForumSubscriptionInfo(CMS.Forums.ForumSubscriptionInfo,System.Boolean,System.String,System.String)"> <summary> Sets (updates or inserts) specified forumSubscription. </summary> <param name="forumSubscription">ForumSubscription to set</param> <param name="sendConfirmationEmail">If confirmation email should be sent or not</param> <param name="baseUrl">Forum base URL</param> <param name="unsubscriptionUrl">Forum un-subscription URL</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.IsSubscribed(System.String,System.Int32,System.Int32)"> <summary> Returns true if current email is already subscribed to the selected forum, post or subpost. </summary> <param name="email">Email</param> <param name="forumId">Forum ID</param> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.IsSubscribed(System.Int32,System.Int32,System.Int32)"> <summary> Returns true if current user is already subscribed to the selected forum, post or subpost. </summary> <param name="userId">User ID</param> <param name="forumId">Forum ID</param> <param name="postId">Post ID</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.DeleteForumSubscriptionInfo(CMS.Forums.ForumSubscriptionInfo)"> <summary> Deletes specified forumSubscription. </summary> <param name="forumSubscriptionObj">ForumSubscription object</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.DeleteForumSubscriptionInfo(CMS.Forums.ForumSubscriptionInfo,System.Boolean)"> <summary> Deletes specified forumSubscription. </summary> <param name="forumSubscriptionObj">ForumSubscription object</param> <param name="sendConfirmationEmail">If confirmation email should be sent or not</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.DeleteForumSubscriptionInfo(System.Int32)"> <summary> Deletes specified forumSubscription. </summary> <param name="forumSubscriptionId">ForumSubscription id</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.DeleteForumSubscriptionInfo(System.Int32,System.Boolean)"> <summary> Deletes specified forumSubscription. </summary> <param name="forumSubscriptionId">ForumSubscription id</param> <param name="sendConfirmationEmail">If confirmation email should be sent or not</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.SendConfirmationEmail(CMS.Forums.ForumSubscriptionInfo,System.Boolean,System.String,System.String)"> <summary> Sends subscription or unsubscription confirmation mail. </summary> <param name="forumSubscription">Forum subscription info</param> <param name="isSubscription">If true subscription email is sent else unsubscription email is sent</param> <param name="baseUrl">Forum base URL</param> <param name="unsubscriptionUrl">Unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.SendDoubleOptInEmail(CMS.Forums.ForumSubscriptionInfo)"> <summary> Sends double opt-in mail. </summary> <param name="forumSubscription">Forum subscription info</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.SendConfirmationEmail(CMS.Forums.ForumSubscriptionInfo,System.Boolean,System.Boolean,System.String,System.String)"> <summary> Sends subscription or unsubscription confirmation mail. </summary> <param name="forumSubscription">Forum 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> <param name="baseUrl">Forum base URL</param> <param name="unsubscriptionUrl">Unsubscription URL</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.Subscribe(CMS.Forums.ForumSubscriptionInfo,System.DateTime,System.Boolean,System.Boolean)"> <summary> Subscribe method intend to subscribe user to forum/forum post and send confirmation/opt-in email </summary> <param name="fsi">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.Forums.ForumSubscriptionInfoProvider.ValidateHash(CMS.Forums.ForumSubscriptionInfo,System.String,System.String,System.DateTime)"> <summary> Validates request hash and checks if request was approved in needed interval. </summary> <param name="fsi">Forum 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.Forums.ForumSubscriptionInfoProvider.GetUnsubscriptionUrl(CMS.Forums.ForumSubscriptionInfo,CMS.Forums.ForumInfo,CMS.Forums.ForumPostInfo,System.String)"> <summary> Returns unsubscription URL which is used to cancel existing subscription </summary> <param name="subscription">Forum subscription object</param> <param name="forum">Forum object</param> <param name="forumPost">Forum post to which user was subscribed</param> <param name="unsubscriptionUrl">Custom unsubscription page URL</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetActivationUrl(CMS.Forums.ForumSubscriptionInfo,CMS.Forums.ForumInfo,CMS.Forums.ForumPostInfo)"> <summary> Returns approval page URL to confirm forum subscription. </summary> <param name="subscription">Forum subscription object</param> <param name="forum">Forum object</param> <param name="forumPost">Forum post to which user was subscribed</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.ApproveSubscription(CMS.Forums.ForumSubscriptionInfo,System.String,System.Boolean,System.String,System.DateTime)"> <summary> Approves existing subscription - sets SubscriptionApproved to true and SubscriptionApprovedWhen to current time. Checks if subscription wasn't already approved. Confirmation e-mail may be sent optionally. </summary> <param name="fsi">Forum subscription object</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 newsletter 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.Forums.ForumSubscriptionInfoProvider.Unsubscribe(System.String,System.Boolean,System.String,System.DateTime)"> <summary> Unsubscribes user from forum or forum 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.Forums.ForumSubscriptionInfoProvider.LogSubscriptionActivity(CMS.Forums.ForumSubscriptionInfo,CMS.Forums.ForumInfo,System.String,System.Boolean)"> <summary> Logs activity using context values. </summary> <param name="fsi">Forum subscription</param> <param name="fi">Forum object</param> <param name="activityType">Activity type to log</param> <param name="checkViewMode">Indicates if view mode should be checked</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.LogSubscriptionActivity(CMS.Forums.ForumSubscriptionInfo,CMS.Forums.ForumInfo,System.Int32,System.Int32,System.String,System.Int32,System.String,System.Boolean)"> <summary> Logs activity. </summary> <param name="fsi">Forum subscription</param> <param name="fi">Forum object</param> <param name="contactId">Contact ID</param> <param name="campaign">Campaign</param> <param name="siteId">Site ID</param> <param name="documentId">Document ID</param> <param name="url">URL</param> <param name="checkViewMode">Indicates if view mode should be checked</param> </member> <member name="M:CMS.Forums.ForumSubscriptionInfoProvider.GetSubscriptionWhereCondition(System.String,System.Int32,System.Int32,System.Int32,System.Boolean)"> <summary> Returns where condition to get the selected forum, post or subpost. </summary> <param name="email">Email</param> <param name="userId">User ID</param> <param name="forumId">Forum ID</param> <param name="postId">Post ID</param> <param name="forceForumCondition">Indicates if also forum condition should be generated</param> </member> <member name="T:CMS.Forums.ThreadViewCounter"> <summary> Class providing support for thread view counting. </summary> </member> <member name="F:CMS.Forums.ThreadViewCounter.ThreadViewCount"> <summary> Hashtable with ThreadID-ViewNumber values. </summary> </member> <member name="F:CMS.Forums.ThreadViewCounter.MaxRecords"> <summary> Number of threads in the hashtable which causes automatic update in DB. </summary> </member> <member name="M:CMS.Forums.ThreadViewCounter.LogThreadView(System.Int32)"> <summary> Increments the number of views of specified post. </summary> <param name="postId">ID of the post the views of which are incremented</param> </member> <member name="M:CMS.Forums.ThreadViewCounter.SaveViewCounts"> <summary> Saves the content of the hashtable to DB. </summary> </member> </members> </doc> |