BlogPosts In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 20:01:18 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:01:18

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IBlogPosts>() and is defined in Telligent.Evolution.Blogs.dll

Events

Events.AfterCreate

Handler

void BlogPostAfterCreateEventHandler([[BlogPostAfterCreateEventArgs In-Process API Event Argument|BlogPostAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void BlogPostAfterDeleteEventHandler([[BlogPostAfterDeleteEventArgs In-Process API Event Argument|BlogPostAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void BlogPostAfterUpdateEventHandler([[BlogPostAfterUpdateEventArgs In-Process API Event Argument|BlogPostAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void BlogPostBeforeCreateEventHandler([[BlogPostBeforeCreateEventArgs In-Process API Event Argument|BlogPostBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void BlogPostBeforeDeleteEventHandler([[BlogPostBeforeDeleteEventArgs In-Process API Event Argument|BlogPostBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void BlogPostBeforeUpdateEventHandler([[BlogPostBeforeUpdateEventArgs In-Process API Event Argument|BlogPostBeforeUpdateEventArgs]] e);

Events.Render

Handler

void BlogPostRenderEventHandler([[BlogPostRenderEventArgs In-Process API Event Argument|BlogPostRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Blog posts content type identifier

Methods

BlogPost Create(int blogId, string title, string body, BlogPostsCreateOptions options = null);

Creates a new blog post

Parameters

Name	Type	Description	Required
blogId	`int`	Id of parent blog	Required
title	`string`	Title of blog post	Required
body	`string`	Content of blog post	Required
options	`[[BlogPostsCreateOptions In-Process API Supplementary Type\|BlogPostsCreateOptions]]`	Optional parameter names are: Slug, Excerpt, ExcerptSize, UsePostSummary, GeneratePostSummary, PublishedDate, IsApproved, Tags, ContentType, FileName, FileData, FileUrl, FileStream, FileUploadContext, IsFeatured, FeaturedImage, ExtendedAttributes,OpenGraphTitle,OpenGraphDescription, OpenGraphImageData, OpenGraphImageContext, MetatTitle, MetaDescription, MetaKeywords	Optional

Return Type

[[BlogPost In-Process API Supplementary Type|BlogPost]]

AdditionalInfo Delete(int id);

Deletes a blog post

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id of the blog post	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

BlogPost Get(BlogPostsGetOptions options);

Gets a blog post

Parameters

Name	Type	Description	Required	Default	Options
options	`[[BlogPostsGetOptions In-Process API Supplementary Type\|BlogPostsGetOptions]]`	Options	Required

Return Type

[[BlogPost In-Process API Supplementary Type|BlogPost]]

BlogPost Get(Guid contentId);

Gets a blog post

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Return Type

[[BlogPost In-Process API Supplementary Type|BlogPost]]

PagedList<BlogPost> List(BlogPostsListOptions options);

Lists blog posts

Parameters

Name	Type	Description	Required	Default	Options
options	`[[BlogPostsListOptions In-Process API Supplementary Type\|BlogPostsListOptions]]`	Optional parameters are: BlogId, BlogIds, GroupId, IncludeSubGroups, ContentIds, IncludeUnpublished, Tags, DateFilter, DateFilterType, LogicallyOrTags, SortBy, SortOrder, PageIndex, PageSize, AuthorId. If left unspecified, sorting defaults to MostRecent Descending.	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[BlogPost In-Process API Supplementary Type|BlogPost]]>

BlogPost Update(int id, BlogPostsUpdateOptions options);

Updates a blog post

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id of the blog post to update	Required
options	`[[BlogPostsUpdateOptions In-Process API Supplementary Type\|BlogPostsUpdateOptions]]`	Optional parameter names are: BlogId, Title, Body, Slug, Excerpt, ExcerptSize, UsePostSummary, GeneratePostSummary, PublishedDate, IsApproved, ContentType, FileName, FileData, FileUrl, FileStream, FileUploadContext, RemoveAttachment, Tags, IsFeatured, FeaturedImage, ExtendedAttributes, OpenGraphTitle,OpenGraphDescription, OpenGraphImageData, OpenGraphImageContext, MetatTitle, MetaDescription, MetaKeywords, RemoveOpenGraphImage	Required

Return Type

[[BlogPost In-Process API Supplementary Type|BlogPost]]