/Web/bin/Telerik.Forums.Data.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Telerik.Forums.Data</name>
    </assembly>
    <members>
        <member name="M:Telerik.Forums.Data.Category.VerifyObject">
            <summary>
            Checks the object state: DeleteCategory, CreateCategory or UpdateCategory. 
            Ends commiting of transaction.
            </summary>
        </member>
        <member name="T:Telerik.Forums.Data.DefaultProvider">
            <summary>
            This class provides methods and properties for working with forum data in SQL Server
            </summary>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.SetVariable(System.String,System.String)">
            <summary>
            Sets a new value for the variable with the specified name.
            </summary>
            <param name="name">the name of the variable to set.</param>
            <param name="value">The new value.</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.SetVariable(System.String,System.String,System.Boolean)">
            <summary>
            Sets a new value for the variable with the specified name.
            </summary>
            <param name="name">the name of the variable to set.</param>
            <param name="value">The new value.</param>
            <param name="global"><see cref="T:System.Boolean"/> value indicating whether application is global.</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetVariable(System.String)">
            <summary>
            Returns the variable with the specified name.
            </summary>
            <returns><see cref="T:System.String"/>string value</returns>
            <param name="name">The name of the variable.</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetVariable(System.String,System.Boolean)">
            <summary>
            Returns variable with the specified name.
            </summary>
            <param name="name">the name of the variable</param>
            <param name="global"><see cref="T:System.Boolean"/> value indicating whether application is global.</param>
            <returns>a string value</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreateForum">
            <summary>
            Overloaded. Creates a new forum
            </summary>
            <returns>IForum object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreateForum(Telerik.Forums.ICategory,System.String,System.Boolean,System.Boolean,Telerik.Forums.ForumStatus)">
            <summary>
            Overloaded. Creates a new forum with specified category
            </summary>
            <param name="category">The category for the forum</param>
            <param name="name">The name of the forum</param>
            <param name="denyAnonymous">True if the forum allows anonymous users to post</param>
            <param name="moderatePosts">True if posts in the forum are approved after being created</param>
            <param name="status">The status of the forum</param>
            <returns>IForum object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreateForum(System.Guid,System.String,System.Boolean,System.Boolean,Telerik.Forums.ForumStatus)">
            <summary>
            Overloaded. Creates a new forum with specified category ID
            </summary>
            <param name="categoryID">ID of the category for the forum</param>
            <param name="name">The name of the forum</param>
            <param name="denyAnonymous">True if the forum allows anonymous users to post</param>
            <param name="moderatePosts">True if posts in the forum are approved after created</param>
            <param name="status">The status of the forum</param>
            <returns>IForum object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.SaveForum(Telerik.Forums.IForum)">
            <summary>
            Saves a Forum
            </summary>
            <param name="forum">IForum object to save</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeleteForum(Telerik.Forums.IForum)">
            <summary>
            Overloaded. Deletes a forum
            </summary>
            <param name="forum">IForum object to delete</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeleteForum(System.Guid)">
            <summary>
            Overloaded. Deletes a forum with specified ID
            </summary>
            <param name="forumID">ID of the forum to be deleted</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForum(System.Guid)">
            <summary>
            Gets a forum
            </summary>
            <param name="forumID">ID of the forum to be retrieved</param>
            <returns>IForum object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForums(System.Boolean)">
            <summary>
            Overloaded. Gets all forums in all categories
            </summary>
            <returns>List of IForum objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForums(Telerik.Forums.ICategory,System.Boolean)">
            <summary>
            Overloaded. Gets all forums in a category
            </summary>
            <returns>List of IForum objects</returns>
            <param name="category">The category, whose forums will be returned</param>
            <param name="excludeHidden">True when setting hidden forums not to be retrieved</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForums(System.Guid[],System.Boolean)">
            <summary>
            Overriden. Gets specific forums by IDs.
            </summary>
            <param name="ids">An array of Guids containing the IDs of the requested forums.</param>
            <param name="excludeHidden">True if you do not want to retrieve hidden forums.</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForums(System.Guid,System.Boolean)">
            <summary>
            Overloaded. Gets all forums in a category
            </summary>
            <param name="categoryID">The ID of the category, whose forums will be returned</param>
            <param name="excludeHidden">True when setting hidden forums not to be retrieved</param>
            <returns>List of IForum objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForumsUncategorized(System.Boolean)">
            <summary>
            Gets all forums that have no assigned category
            </summary>
            <param name="excludeHidden">True when setting hidden forums not to be retrieved</param>
            <returns></returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetRecentForums(System.Int32,System.Int32)">
            <summary>
            Gets the recent forumns.
            </summary>
            <param name="start">The start.</param>
            <param name="max">The max.</param>
            <param name="total"></param>
            <returns></returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreatePost">
            <summary>
            Overloaded. Creates a new forum post.
            </summary>
            <returns>IPost object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreatePost(System.Guid)">
            <summary>
            Overloaded. Creates a new forum post given the specified parent.
            </summary>
            <param name="parentID">ID of the post, whose child is to be created</param>
            <returns>IPost object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreatePost(Telerik.Forums.IPost)">
            <summary>
            Overloaded. Creates a new forum post with specified parent
            </summary>
            <param name="parent">The post, whose child is to be created</param>
            <returns>IPost object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.SavePost(Telerik.Forums.IPost)">
            <summary>
            Saves a forum post.
            </summary>
            <param name="post">The post to be saved</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeletePost(Telerik.Forums.IPost)">
            <summary>
            Overloaded. Deletes a forum post
            </summary>
            <param name="post">The post to be deleted</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeletePost(System.Guid)">
            <summary>
            Overloaded. Deletes a forum post with the given ID
            </summary>
            <param name="postID">ID of the post to be deleted</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetPost(System.Guid)">
            <summary>
            Gets a forum post.
            </summary>
            <param name="postID">The ID of the post to get</param>
            <returns>IPost object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetPosts(System.Guid,System.Boolean,System.Boolean)">
            <summary>
            Overloaded. Gets all children posts of the specified parent
            </summary>
            <param name="parentThreadID">The ID of the parent thread</param>
            <param name="descending">True if you want to sort the results in descending order</param>
            <param name="visibleOnly">True if you only want to retrieve visible posts</param>
            <returns>List of IPost objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetPostsByAuthor(System.String)">
            <summary>
            Gets all children posts written by the specified user
            </summary>
            <param name="parentID">The username of the author</param>
            <param name="authorName">The name of the user whose posts are to be retrieved</param>
            <returns>List of IPost objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetPosts(Telerik.Forums.IPost)">
            <summary>
            Overloaded. Gets all children posts of the speficied parent
            </summary>
            <param name="parent">The parent post</param>
            <returns>List of IPost objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForumPosts(Telerik.Forums.IForum)">
            <summary>
            Overloaded. Gets all posts in a forum
            </summary>
            <param name="parentForum">The parent forum</param>
            <returns>List of IPost objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForumPosts(System.Guid)">
            <summary>
            Overloaded. Gets all posts in a forum
            </summary>
            <param name="parentForumID">The ID of the parent forum</param>
            <returns>List of IPost objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetRecentPosts(System.Int32,System.Int32)">
            <summary>
            Gets the recent posts.
            </summary>
            <param name="start">The start.</param>
            <param name="max">The max.</param>
            <returns></returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForumThreads(Telerik.Forums.IForum,System.Boolean)">
            <summary>
            Overloaded. Gets all threads in a forum
            </summary>
            <param name="parentForum">The parent forum</param>
            <returns></returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetForumThreads(System.Guid,System.Boolean)">
            <summary>
            Overloaded. Gets all threads in a forum
            </summary>
            <param name="parentForumID">The ID of the parent forum</param>
            <returns></returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreateCategory">
            <summary>
            Overloaded. Creates a category
            </summary>
            <returns>ICategory object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.CreateCategory(System.String)">
            <summary>
            Overloaded. Creates a category with the given name
            </summary>
            <param name="name">The name of the category to be created</param>
            <returns>ICategory object</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.SaveCategory(Telerik.Forums.ICategory)">
            <summary>
            Saves a category
            </summary>
            <param name="category">The category to be saved</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeleteCategory(Telerik.Forums.ICategory)">
            <summary>
            Overloaded. Deletes a category
            </summary>
            <param name="category">The category to be deleted</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.DeleteCategory(System.Guid)">
            <summary>
            Overloaded. Deletes a category
            </summary>
            <param name="categoryID">The ID of the category to be deleted</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetCategory(System.Guid)">
            <summary>
            Gets a category
            </summary>
            <param name="categoryID">The ID of the category to retrieve</param>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetCategories">
            <summary>
            Overloaded. Gets all categories
            </summary>
            <returns>List of ICategory objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetCategories(System.String)">
            <summary>
            Overloaded. Gets all categories sorted
            </summary>
            <param name="sortExpr">The sort expression to sort the list of categories</param>
            <returns>List of ICategory objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.GetCategoriesByIds(System.Guid[])">
            <summary>
            Overloaded. Gets categories with the specified IDs
            </summary>
            <param name="ids">A Guid array, containing the IDs of the categories to get</param>
            <returns>List of ICategory objects</returns>
        </member>
        <member name="M:Telerik.Forums.Data.DefaultProvider.Initialize(System.String,System.Collections.Specialized.NameValueCollection)">
            <summary>
            Initializes the provider.
            </summary>
            <param name="name">The friendly name of the provider.</param>
            <param name="config"><para>A collection of the name/value pairs representing the provider-specific
                attributes specified in the configuration for this provider.</para></param>
        </member>
        <member name="P:Telerik.Forums.Data.DefaultProvider.Application">
            <summary>
            Returns the current application 
            </summary>
        </member>
        <member name="T:Telerik.Forums.Data.Forum">
            <summary>Represents a single forum</summary>
        </member>
        <member name="M:Telerik.Forums.Data.Forum.DeleteObject">
            <summary>
            This method does a cascading delete (when the forum is deleted, all
            posts in the forum are deleted, too)
            </summary>
        </member>
        <member name="M:Telerik.Forums.Data.Forum.VerifyObject">
            <summary>
            Checks the object state: DeleteForum, CreateForum or UpdateForum. 
            Ends commiting of transaction.
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Forum.PostsCount">
            <summary>Gets the number of posts in the forum</summary>
        </member>
        <member name="P:Telerik.Forums.Data.Forum.ThreadsCount">
            <summary>Gets the number of threads in the forum</summary>
        </member>
        <member name="T:Telerik.Forums.Data.Forums">
            <summary>A nolics query to return forums</summary>
        </member>
        <member name="M:Telerik.Forums.Data.Post.VerifyObject">
            <summary>
            Checks the object state: DeletePost, CreatePost or UpdatePost. 
            Ends commiting of transaction.
            </summary>
        </member>
        <member name="T:Telerik.Forums.Data.Posts">
            <summary>
            A query to get all posts in a forum
            </summary>
        </member>
        <member name="T:Telerik.Forums.Data.Resources.Messages">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Resources.Messages.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Resources.Messages.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Resources.Messages.DefaultProviderDescription">
            <summary>
              Looks up a localized string similar to Forums Data Provider for Nolics.
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Resources.Messages.ItemBelongsToOtherProvider">
            <summary>
              Looks up a localized string similar to This item belongs to a different provider..
            </summary>
        </member>
        <member name="P:Telerik.Forums.Data.Resources.Messages.NotSupportedType">
            <summary>
              Looks up a localized string similar to The type {0} is not supported by this provider..
            </summary>
        </member>
    </members>
</doc>