Blogs In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:05 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:05

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

Events

Events.AfterCreate

Handler

void BlogAfterCreateEventHandler([[BlogAfterCreateEventArgs In-Process API Event Argument|BlogAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void BlogAfterDeleteEventHandler([[BlogAfterDeleteEventArgs In-Process API Event Argument|BlogAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void BlogAfterUpdateEventHandler([[BlogAfterUpdateEventArgs In-Process API Event Argument|BlogAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void BlogBeforeCreateEventHandler([[BlogBeforeCreateEventArgs In-Process API Event Argument|BlogBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void BlogBeforeDeleteEventHandler([[BlogBeforeDeleteEventArgs In-Process API Event Argument|BlogBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void BlogBeforeUpdateEventHandler([[BlogBeforeUpdateEventArgs In-Process API Event Argument|BlogBeforeUpdateEventArgs]] e);

Events.Render

Handler

void BlogRenderEventHandler([[BlogRenderEventArgs In-Process API Event Argument|BlogRenderEventArgs]] e);

Events.SelectTheme

Handler

void BlogSelectThemeEventHandler([[BlogSelectThemeEventArgs In-Process API Event Argument|BlogSelectThemeEventArgs]] e);

Properties

Name	Type	Description
ApplicationTypeId	`Guid`	Blogs application type identifier
ContentTypeId	`Guid`	Blogs content type identifier
ThemeTypeId	`Guid`	Blogs theme type identifier
TotalLicensed	`int`
TotalLicensedRemaining	`int`

Methods

Blog Create(int groupId, string name, BlogsCreateOptions options = null);

Creates a new blog

Parameters

Name	Type	Description	Required
groupId	`int`	Group in which to create the blog	Required
name	`string`	Name of the blog	Required
options	`[[BlogsCreateOptions In-Process API Supplementary Type\|BlogsCreateOptions]]`	Optional parameter names are: Key, Description, Authors (comma separated list of usernames), Enabled, ExtendedAttributes	Optional

Return Type

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

BlogContactRequest CreateContactRequest(int blogId, string subject, string body, string name, string emailAddress, DateTime dateCreated, IPAddress ipAddress);

Creates a blog contact request

Parameters

Name	Type	Description	Required
blogId	`int`	Blog Id	Required
subject	`string`	Subject	Required
body	`string`	Body	Required
name	`string`	Name	Required
emailAddress	`string`	Email address	Required
dateCreated	`DateTime`	Date created	Required
ipAddress	`IPAddress`	IP address	Required

Return Type

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

AdditionalInfo Delete(int id);

Deletes a blog

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Blog Id	Required

Return Type

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

AdditionalInfo DeleteContactRequest(int blogId, int id);

Deletes a blog contact request

Parameters

Name	Type	Description	Required	Default	Options
blogId	`int`	Blog Id	Required
id	`int`	Contact Request Id	Required

Return Type

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

Blog Get(BlogsGetOptions options);

Gets a blog

Parameters

Name	Type	Description	Required	Default	Options
options	`[[BlogsGetOptions In-Process API Supplementary Type\|BlogsGetOptions]]`	Optional parameter names are: Id, Key, GroupId	Required

Return Type

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

Blog Get(Guid applicationId);

Gets a blog

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Id of the Blog	Required

Return Type

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

BlogContactRequest GetContactRequest(int id);

Gets a blog contact request

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Blog Id	Required

Return Type

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

PagedList<Blog> List(BlogsListOptions options = null);

Returns a queried listing of blogs

Parameters

Name	Type	Description	Required	Default	Options
options	`[[BlogsListOptions In-Process API Supplementary Type\|BlogsListOptions]]`	Optional parameter names are: GroupId, IncludeSubGroups, ApplicationIds, PageIndex, PageSize, OwnerUserId, UserId, PermissionId, SortBy, SortOrder. If left unspecified, sorting defaults to SortOrder Ascending.	Optional

Return Type

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

PagedList<BlogContactRequest> ListContactRequests(int blogId, BlogContactListOptions options = null);

Lists blog contact requests

Parameters

Name	Type	Description	Required	Default	Options
blogId	`int`	Blog Id	Required
options	`[[BlogContactListOptions In-Process API Supplementary Type\|BlogContactListOptions]]`	Optional Parameters are: IsModerated, PageIndex, PageSize	Optional

Return Type

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

Blog Update(int id, BlogsUpdateOptions options);

Updates a blog

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Blog Id	Required
options	`[[BlogsUpdateOptions In-Process API Supplementary Type\|BlogsUpdateOptions]]`	Optional parameter names are: GroupId, Name, Key, Description, Authors (comma separated list of usernames), Enabled, ExtendedAttribute	Required

Return Type

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