C# Class Engage.Dnn.Publish.Article

Inheritance: Item

Show file Open project: EngageSoftware/Engage-Publish Class Usage Examples

Private Properties

Property	Type	Description
CreateArticle	Article
GetArticle	Article
SetDefaultItemVersionSettings	void

Public Methods

Method	Description
AddArticleVersion ( IDbTransaction trans, int itemVersionId, int itemId, string versionNumber, string versionDescription, string articleText, string referenceNumber ) : void
AddArticleVersion ( int itemVersionId, int itemId, string versionNumber, string versionDescription, string articleText, string referenceNumber ) : void
AddRating ( int rating, int userId ) : void
Article ( ) : System
Create ( int portalId ) : Article
Create ( string name, string description, string articleText, int authorUserId, int parentCategoryId, int moduleId, int portalId ) : Article	Creates an Article object that you can continue to modify or save back into the database.
DisplayReturnToList ( ) : bool
GetArticle ( int itemId, int portalId ) : Article
GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags ) : Article
GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Article
GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings, bool ignoreCache ) : Article
GetArticleVersion ( int articleVersionId, int portalId ) : Article
GetArticleVersion ( int articleVersionId, int portalId, bool ignoreCache ) : Article
GetArticles ( int portalId ) : DataTable
GetArticles ( int parentItemId, int portalId ) : DataTable
GetArticlesByModuleId ( int moduleId, bool isCurrent ) : DataTable
GetArticlesByPortalId ( int portalId ) : DataTable
GetArticlesSearchIndexingNew ( int portalId, int displayTabId ) : DataTable
GetArticlesSearchIndexingUpdated ( int portalId, int moduleDefId, int displayTabId ) : DataTable
GetOldArticleId ( int itemId ) : int
GetPage ( int pageId ) : string
Import ( int currentModuleId, int portalId ) : void	This method is invoked by the Import mechanism and has to take this instance of a Article and resolve all the id's using the names supplied in the export. hk
Save ( int revisingUserId ) : void
UpdateApprovalStatus ( ) : void

Protected Methods

Method	Description
ResolveIds ( int currentModuleId ) : void

Private Methods

Method	Description
CreateArticle ( string name, string description, string articleText, int authorUserId, int parentCategoryId, int moduleId, int portalId ) : Article
GetArticle ( int itemId ) : Article
SetDefaultItemVersionSettings ( ) : void	This method will configure the default ItemVersionSettings for an article, it is called from the Create method on article so that users of the API do not have to pass in itemversionsettings.

Method Details

AddArticleVersion() public static method

public static AddArticleVersion ( IDbTransaction trans, int itemVersionId, int itemId, string versionNumber, string versionDescription, string articleText, string referenceNumber ) : void
trans	IDbTransaction
itemVersionId	int
itemId	int
versionNumber	string
versionDescription	string
articleText	string
referenceNumber	string
return	void

AddArticleVersion() public static method

public static AddArticleVersion ( int itemVersionId, int itemId, string versionNumber, string versionDescription, string articleText, string referenceNumber ) : void
itemVersionId	int
itemId	int
versionNumber	string
versionDescription	string
articleText	string
referenceNumber	string
return	void

AddRating() public method

public AddRating ( int rating, int userId ) : void
rating	int
userId	int
return	void

Article() public method

public Article ( ) : System
return	System

Create() public static method

public static Create ( int portalId ) : Article
portalId	int
return	Article

Create() public static method

Creates an Article object that you can continue to modify or save back into the database.

public static Create ( string name, string description, string articleText, int authorUserId, int parentCategoryId, int moduleId, int portalId ) : Article
name	string	Name of the Category to be created.
description	string	The description/abstract of the category to be created.
articleText	string
authorUserId	int	The ID of the author of this category.
parentCategoryId	int
moduleId	int	The moduleid for where this category will most likely be displayed.
portalId	int	The Portal ID of the portal this category belongs to.
return	Article

DisplayReturnToList() public method

public DisplayReturnToList ( ) : bool
return	bool

GetArticle() public static method

public static GetArticle ( int itemId, int portalId ) : Article
itemId	int
portalId	int
return	Article

GetArticle() public static method

public static GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags ) : Article
itemId	int
portalId	int
loadRelationships	bool
loadTags	bool
return	Article

GetArticle() public static method

public static GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings ) : Article
itemId	int
portalId	int
loadRelationships	bool
loadTags	bool
loadItemVersionSettings	bool
return	Article

GetArticle() public static method

public static GetArticle ( int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings, bool ignoreCache ) : Article
itemId	int
portalId	int
loadRelationships	bool
loadTags	bool
loadItemVersionSettings	bool
ignoreCache	bool
return	Article

GetArticleVersion() public static method

public static GetArticleVersion ( int articleVersionId, int portalId ) : Article
articleVersionId	int
portalId	int
return	Article

GetArticleVersion() public static method

public static GetArticleVersion ( int articleVersionId, int portalId, bool ignoreCache ) : Article
articleVersionId	int
portalId	int
ignoreCache	bool
return	Article

GetArticles() public static method

public static GetArticles ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetArticles() public static method

public static GetArticles ( int parentItemId, int portalId ) : DataTable
parentItemId	int
portalId	int
return	System.Data.DataTable

GetArticlesByModuleId() public static method

public static GetArticlesByModuleId ( int moduleId, bool isCurrent ) : DataTable
moduleId	int
isCurrent	bool
return	System.Data.DataTable

GetArticlesByPortalId() public static method

public static GetArticlesByPortalId ( int portalId ) : DataTable
portalId	int
return	System.Data.DataTable

GetArticlesSearchIndexingNew() public static method

public static GetArticlesSearchIndexingNew ( int portalId, int displayTabId ) : DataTable
portalId	int
displayTabId	int
return	System.Data.DataTable

GetArticlesSearchIndexingUpdated() public static method

public static GetArticlesSearchIndexingUpdated ( int portalId, int moduleDefId, int displayTabId ) : DataTable
portalId	int
moduleDefId	int
displayTabId	int
return	System.Data.DataTable

GetOldArticleId() public static method

public static GetOldArticleId ( int itemId ) : int
itemId	int
return	int

GetPage() public method

public GetPage ( int pageId ) : string
pageId	int
return	string

Import() public method

This method is invoked by the Import mechanism and has to take this instance of a Article and resolve all the id's using the names supplied in the export. hk

public Import ( int currentModuleId, int portalId ) : void
currentModuleId	int
portalId	int
return	void

ResolveIds() protected method

protected ResolveIds ( int currentModuleId ) : void
currentModuleId	int
return	void

Save() public method

public Save ( int revisingUserId ) : void
revisingUserId	int
return	void

UpdateApprovalStatus() public method

public UpdateApprovalStatus ( ) : void
return	void