Home · Blog · Download · Docs · About

SDK

BigBlog.SDK API Documentation

BigBlogSortOrder (Enum)

Specifies the sort order for blog posts.

Fields

• Natural - Natural order - no specific sorting applied.
• Ascending - Ascending order by publication date.
• Descending - Descending order by publication date.

BigBlogQuery (Class)

Represents query parameters for filtering and paginating blog posts from the database.

Properties

• Page - The page number for pagination (1-based).
• PageSize - The number of posts per page. Defaults to all posts.
• Category - The category to filter posts by.
• StartDate - The start date to filter posts from (inclusive).
• EndDate - The end date to filter posts to (inclusive).
• Slug - The slug to filter posts by. When specified, returns only the post with the matching slug.
• SortOrder - The sort order for the posts. If null, defaults to natural order.

Constructors

• BigBlogQuery() - Initializes a new instance of the BigBlogQuery class with default values. Default configuration retrieves all posts without filtering or pagination.
• BigBlogQuery(int page, int pageSize, string category, DateTime? startDate, DateTime? endDate, string slug, BigBlogSortOrder? sortOrder) - Initializes a new instance of the BigBlogQuery class with the specified parameters.
  • page - The page number for pagination (1-based).
  • pageSize - The number of posts per page. Use -1 for no pagination.
  • category - The category to filter posts by, or null for no category filtering.
  • startDate - The earliest publication date to include, or null for no start date filtering.
  • endDate - The latest publication date to include, or null for no end date filtering.
  • slug - The specific post slug to retrieve, or null for no slug filtering.
  • sortOrder - The sort order for the posts, or null for natural order.

IBigBlogReader (Interface)

Provides read-only access to blog posts with querying and retrieval capabilities.

Methods

• QueryPostsAsync(BigBlogQuery query) - Queries blog posts based on the specified criteria.

  • query - The query parameters including pagination, date range, and category filters.
  • Returns: A list of blog posts matching the query criteria.

• GetPostAsync(int id) - Gets a specific blog post by its unique identifier.

  • id - The unique identifier of the blog post.
  • Returns: The blog post, or null if not found.

• GetCategoriesAsync() - Get a list of the categories available in the blog.

  • Returns: A list of category names.

BigBlogReaderExtensions (Static Class)

Extension methods that provide convenient access patterns for blog post retrieval.

Methods

• GetAllPostsAsync(IBigBlogReader blog) - Gets all available blog posts without any filtering or pagination.

  • blog - The blog reader instance.
  • Returns: A list of all blog posts in the system.
  • Throws: ArgumentNullException when blog is null.

• GetCategoryPostsAsync(IBigBlogReader blog, string category) - Gets all posts within a specific category.

  • blog - The blog reader instance.
  • category - The category name to filter by.
  • Returns: A list of blog posts in the specified category.
  • Throws: ArgumentNullException when blog is null.

• FindDatedPostsAsync(IBigBlogReader blog, int year, string slug) - Gets all posts published within a specific date range.

  • blog - The blog reader instance.
  • year - The year of the post to find.
  • slug - The slug of the post to find.
  • Returns: A list of blog posts within the specified date range.
  • Throws: ArgumentNullException when blog is null.

BlogPost (Class)

Represents a blog post entity.

Note: Located in BigBlog.Sqlite namespace