Interface IJournalController

Namespace: DotNetNuke.Services.Journal

Assembly: DotNetNuke.dll

Syntax

public interface IJournalController

Methods

DeleteComment(Int32, Int32)

Delete a comment by id.

Declaration

void DeleteComment(int journalId, int commentId)

Parameters

Type	Name	Description
System.Int32	journalId	Id of journal.
System.Int32	commentId	Id of comment.

DeleteJournalItem(Int32, Int32, Int32)

Hard delete journal item by journal id.

Declaration

void DeleteJournalItem(int portalId, int userId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user.
System.Int32	journalId	Id of the journal want to delete.

DeleteJournalItemByGroupId(Int32, Int32)

Hard delete journal items based on group Id.

Declaration

void DeleteJournalItemByGroupId(int portalId, int groupId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	groupId	Id of social group.

DeleteJournalItemByKey(Int32, String)

Hard delete journal item by object key.

Declaration

void DeleteJournalItemByKey(int portalId, string objectKey)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.String	objectKey	Object key.

DisableComments(Int32, Int32)

Disable comment on a journal item.

Declaration

void DisableComments(int portalId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	journalId	Id of the journal want to disable comment.

EnableComments(Int32, Int32)

Enable comment on a journal item.

Declaration

void EnableComments(int portalId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	journalId	Id of the journal want to enable comment.

GetComment(Int32)

Get comment info object by comment id.

Declaration

CommentInfo GetComment(int commentId)

Parameters

Type	Name	Description
System.Int32	commentId	Id of the comment.

Returns

Type	Description
CommentInfo	Comment info object.

GetCommentsByJournalIds(List<Int32>)

Get all comments in the given journal items.

Declaration

IList<CommentInfo> GetCommentsByJournalIds(List<int> journalIdList)

Parameters

Type	Name	Description
List<System.Int32>	journalIdList	Id list of journal items.

Returns

Type	Description
IList<CommentInfo>	CommentInfo object list.

GetJournalItem(Int32, Int32, Int32, Boolean, Boolean, Boolean)

Get journal info.

Declaration

JournalItem GetJournalItem(int portalId, int userId, int journalId, bool includeAllItems, bool isDeleted, bool securityCheck)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user, if securityCheck set as True, will check whether this user has permission to view the journal.
System.Int32	journalId	Id of Journal.
System.Boolean	includeAllItems	Whether include deleted items.
System.Boolean	isDeleted	Whether get deleted item.
System.Boolean	securityCheck	Whether check current user has permission to get journal.

Returns

Type	Description
JournalItem	Journal Object.

GetJournalItem(Int32, Int32, Int32, Boolean, Boolean)

Get journal info.

Declaration

JournalItem GetJournalItem(int portalId, int userId, int journalId, bool includeAllItems, bool isDeleted)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user, if securityCheck set as True, will check whether this user has permission to view the journal.
System.Int32	journalId	Id of Journal.
System.Boolean	includeAllItems	Whether include deleted items.
System.Boolean	isDeleted	Whether get deleted item.

Returns

Type	Description
JournalItem	Journal Object.

GetJournalItem(Int32, Int32, Int32, Boolean)

Get journal info.

Declaration

JournalItem GetJournalItem(int portalId, int userId, int journalId, bool includeAllItems)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user, if securityCheck set as True, will check whether this user has permission to view the journal.
System.Int32	journalId	Id of Journal.
System.Boolean	includeAllItems	Whether include deleted items.

Returns

Type	Description
JournalItem	Journal Object.

GetJournalItem(Int32, Int32, Int32)

Get journal info.

Declaration

JournalItem GetJournalItem(int portalId, int userId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user, if securityCheck set as True, will check whether this user has permission to view the journal.
System.Int32	journalId	Id of Journal.

Returns

Type	Description
JournalItem	Journal Object.

GetJournalItemByKey(Int32, String, Boolean, Boolean)

Get journal item by object key.

Declaration

JournalItem GetJournalItemByKey(int portalId, string objectKey, bool includeAllItems, bool isDeleted)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.String	objectKey	The object key.
System.Boolean	includeAllItems	Whether include deleted items.
System.Boolean	isDeleted	Whether get deleted item.

Returns

Type	Description
JournalItem	Journal Object.

GetJournalItemByKey(Int32, String, Boolean)

Get journal item by object key.

Declaration

JournalItem GetJournalItemByKey(int portalId, string objectKey, bool includeAllItems)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.String	objectKey	The object key.
System.Boolean	includeAllItems	Whether include deleted items.

Returns

Type	Description
JournalItem	Jornal Object.

GetJournalItemByKey(Int32, String)

Get journal item by object key.

Declaration

JournalItem GetJournalItemByKey(int portalId, string objectKey)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.String	objectKey	The object key.

Returns

Type	Description
JournalItem	Journal object.

GetJournalType(String)

Get journal type by name.

Declaration

JournalTypeInfo GetJournalType(string journalType)

Parameters

Type	Name	Description
System.String	journalType	type name.

Returns

Type	Description
JournalTypeInfo	Journal type object.

GetJournalTypeById(Int32)

Get journal type by type id.

Declaration

JournalTypeInfo GetJournalTypeById(int journalTypeId)

Parameters

Type	Name	Description
System.Int32	journalTypeId	Type id.

Returns

Type	Description
JournalTypeInfo	Journal type object.

GetJournalTypes(Int32)

Get all journal types in portal.

Declaration

IEnumerable<JournalTypeInfo> GetJournalTypes(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.

Returns

Type	Description
IEnumerable<JournalTypeInfo>	Enumerable JournalTypeInfo object list.

HideComments(Int32, Int32)

Hide comments on a journal item.

Declaration

void HideComments(int portalId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	journalId	Id of the journal want to hide comments.

LikeComment(Int32, Int32, Int32, String)

Save a like on comment.

Declaration

void LikeComment(int journalId, int commentId, int userId, string displayName)

Parameters

Type	Name	Description
System.Int32	journalId	Id of journal.
System.Int32	commentId	Id of comment.
System.Int32	userId	Id of current user.
System.String	displayName	User's display name.

LikeJournalItem(Int32, Int32, String)

Save a like on journal item.

Declaration

void LikeJournalItem(int journalId, int userId, string displayName)

Parameters

Type	Name	Description
System.Int32	journalId	Id of journal item.
System.Int32	userId	Id of current user.
System.String	displayName	User's display name.

SaveComment(CommentInfo)

Save comment info object into database.

Declaration

void SaveComment(CommentInfo ci)

Parameters

Type	Name	Description
CommentInfo	ci	Comment info object.

SaveJourmalFile(ModuleInfo, UserInfo, String, Stream)

Save an uploaded file.

Declaration

IFileInfo SaveJourmalFile(ModuleInfo module, UserInfo userInfo, string fileName, Stream fileContent)

Parameters

Type	Name	Description
ModuleInfo	module	Module where the file is uploaded.
UserInfo	userInfo	User who uploads the file.
System.String	fileName	File Name.
Stream	fileContent	File content.

Returns

Type	Description
IFileInfo	A FileInfo object corresponding to the saved file.

SaveJournalItem(JournalItem, ModuleInfo)

Save the journal object into database.

Declaration

void SaveJournalItem(JournalItem journalItem, ModuleInfo module)

Parameters

Type	Name	Description
JournalItem	journalItem	Journal object.
ModuleInfo	module	The module info of journal item context.

SaveJournalItem(JournalItem, Int32)

Declaration

void SaveJournalItem(JournalItem journalItem, int tabId)

Parameters

Type	Name	Description
JournalItem	journalItem
System.Int32	tabId

ShowComments(Int32, Int32)

Show comments on a journal item.

Declaration

void ShowComments(int portalId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	journalId	Id of the journal want to show comment.

SoftDeleteJournalItem(Int32, Int32, Int32)

Soft delete journal item by journal id.

Declaration

void SoftDeleteJournalItem(int portalId, int userId, int journalId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	userId	Id of current user.
System.Int32	journalId	Id of the journal want to delete.

SoftDeleteJournalItemByGroupId(Int32, Int32)

Soft delete journal items based on group Id.

Declaration

void SoftDeleteJournalItemByGroupId(int portalId, int groupId)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.Int32	groupId	Id of social group.

SoftDeleteJournalItemByKey(Int32, String)

Soft delete journal item by object key.

Declaration

void SoftDeleteJournalItemByKey(int portalId, string objectKey)

Parameters

Type	Name	Description
System.Int32	portalId	Id of portal.
System.String	objectKey	Object key.

UpdateJournalItem(JournalItem, ModuleInfo)

Update the journal info in database.

Declaration

void UpdateJournalItem(JournalItem journalItem, ModuleInfo module)

Parameters

Type	Name	Description
JournalItem	journalItem	Journal object.
ModuleInfo	module	The module info of journal item context.

UpdateJournalItem(JournalItem, Int32)

Declaration

void UpdateJournalItem(JournalItem journalItem, int tabId)

Parameters

Type	Name	Description
JournalItem	journalItem
System.Int32	tabId

Extension Methods

JsonExtensionsWeb.ToJson(Object)