Class OpenBiBlogExtensions

Extension methods for blogs and blog articles.

Inheritance

object

OpenBiBlogExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.Blogs

Assembly: BiExcellence.OpenBi.Api.Blog.dll

Syntax

public static class OpenBiBlogExtensions

Methods

CreateBlogArticleAsync(IOpenBiSession, IBlog, IBlogArticle, CancellationToken)

Creates or updates a blog article.

Declaration

public static Task CreateBlogArticleAsync(this IOpenBiSession session, IBlog blog, IBlogArticle blogArticle, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBlog	blog	The blog.
IBlogArticle	blogArticle	The blog article.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateBlogArticleAsync(IOpenBiSession, string, IBlogArticle, CancellationToken)

Creates or updates a blog article.

Declaration

public static Task CreateBlogArticleAsync(this IOpenBiSession session, string blogId, IBlogArticle blogArticle, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	blogId	The blog id.
IBlogArticle	blogArticle	The blog article.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateBlogAsync(IOpenBiSession, IBlog, CancellationToken)

Creates or updates a blog.

Declaration

public static Task CreateBlogAsync(this IOpenBiSession session, IBlog blog, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBlog	blog	The blog.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogArticleAsync(IOpenBiSession, IBlogArticle, CancellationToken)

Deletes a blog article.

Declaration

public static Task DeleteBlogArticleAsync(this IOpenBiSession session, IBlogArticle blogArticle, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBlogArticle	blogArticle	The blog article.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogArticleAsync(IOpenBiSession, string, CancellationToken)

Deletes a blog article by id.

Declaration

public static Task DeleteBlogArticleAsync(this IOpenBiSession session, string blogArticleId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	blogArticleId	The blog article id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogArticlesAsync(IOpenBiSession, IEnumerable<IBlogArticle>, CancellationToken)

Deletes blog articles.

Declaration

public static Task DeleteBlogArticlesAsync(this IOpenBiSession session, IEnumerable<IBlogArticle> blogArticles, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IBlogArticle>	blogArticles	The blog articles.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogArticlesAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes blog articles by id.

Declaration

public static Task DeleteBlogArticlesAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<string>	ids	The blog article ids.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogAsync(IOpenBiSession, IBlog, CancellationToken)

Deletes a blog.

Declaration

public static Task DeleteBlogAsync(this IOpenBiSession session, IBlog blog, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBlog	blog	The blog.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogAsync(IOpenBiSession, string, CancellationToken)

Deletes a blog by id.

Declaration

public static Task DeleteBlogAsync(this IOpenBiSession session, string blogId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	blogId	The blog id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogsAsync(IOpenBiSession, IEnumerable<IBlog>, CancellationToken)

Deletes blogs.

Declaration

public static Task DeleteBlogsAsync(this IOpenBiSession session, IEnumerable<IBlog> blogs, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IBlog>	blogs	The blogs.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBlogsAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes blogs by id.

Declaration

public static Task DeleteBlogsAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<string>	ids	The blog ids.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

GetBlogArticles(IOpenBiSession, IBlog)

Returns blog articles for a blog.

Declaration

public static IListRequest<IBlogArticle> GetBlogArticles(this IOpenBiSession session, IBlog blog)

Parameters

Type	Name	Description
IOpenBiSession	session	The seesion.
IBlog	blog	The blog.

Returns

Type	Description
IListRequest<IBlogArticle>

GetBlogArticles(IOpenBiSession, string)

Returns blog articles for a blog.

Declaration

public static IListRequest<IBlogArticle> GetBlogArticles(this IOpenBiSession session, string blogId)

Parameters

Type	Name	Description
IOpenBiSession	session	The seesion.
string	blogId	The blog id.

Returns

Type	Description
IListRequest<IBlogArticle>

GetBlogByIdAsync(IOpenBiSession, string, CancellationToken)

Returns a blog by its id.

Declaration

public static Task<IBlog?> GetBlogByIdAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	id	The blog id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IBlog>

GetBlogsAsync(IOpenBiSession, CancellationToken)

Returns all blogs.

Declaration

public static Task<IList<IBlog>> GetBlogsAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IBlog>>