ArticleCollection In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:33:57 GMT

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

Content created on the site must implement this interface for the social services to support it.

ArticleCollection is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace of Telligent.Evolution.Articles.dll

Definition

class ArticleCollection
{
	Guid ApplicationId { get;  }
	Guid ApplicationTypeId { get;  }
	Guid ContentId { get;  }
	Guid ContentTypeId { get;  }
	DateTime? CreateDate { get; set;  }
	[[User In-Process API Supplementary Type|User]] CreatedBy { get; set;  }
	[[Article In-Process API Supplementary Type|Article]] DefaultArticle { get; set;  }
	[[ArticleType In-Process API Supplementary Type|ArticleType]] DefaultType { get; set;  }
	DateTime? DeleteDate { get; set;  }
	string Description { get; set;  }
	bool? EnableHelpfulness { get; set;  }
	[[Group In-Process API Supplementary Type|Group]] Group { get; set;  }
	Guid? Id { get; set;  }
	bool? IsDeleted { get; set;  }
	bool? IsEnabled { get; set;  }
	string Name { get; set;  }
	string Prefix { get; set;  }
	Guid? ThemeId { get; set;  }
	string Url { get; set;  }
	string UrlKey { get; set;  }
	string HtmlDescription(string target);
}

Properties

Name	Type	Description
ApplicationId	`Guid`	A Guid uniquely identifying the application.
ApplicationTypeId	`Guid`	A Guid identifying the type of application. All applications of the same type (i.e. wiki) will have the same value here.
ContentId	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	`Guid`	A Guid identifying the type of content. All content of the same type (i.e. wiki page) will have the same value here.
CreateDate	`DateTime?`
CreatedBy	`[[User In-Process API Supplementary Type\|User]]`
DefaultArticle	`[[Article In-Process API Supplementary Type\|Article]]`
DefaultType	`[[ArticleType In-Process API Supplementary Type\|ArticleType]]`
DeleteDate	`DateTime?`
Description	`string`
EnableHelpfulness	`bool?`
Group	`[[Group In-Process API Supplementary Type\|Group]]`
Id	`Guid?`
IsDeleted	`bool?`
IsEnabled	`bool?`
Name	`string`
Prefix	`string`
ThemeId	`Guid?`
Url	`string`	A Url to the application on the site.
UrlKey	`string`

Methods

string HtmlDescription(string target);

This method should return the Html encoded description of the application. Possible values for “target” are “Web”, “Email”, “WebServices”, or “raw”. When “raw” is specified as the target, the description should not be encoded or have any special rendering done to it. If there is no description, an empty string should be returned.

Parameters

Name	Type	Description	Required	Default	Options
target	`string`	Target	Required

Return Type

string