Ektron.Cms.Framework.Community.PrivateMessageManager

Private Message Manager

Properties
ApiMode Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
ContentLanguage Gets or sets the current content language.
InPreviewMode Gets or sets the current Preview Mode. Returns true if the site is in site preview mode.
MessageManagerService returns an instance of the business objects message manager service.
RequestInformation Gets the current Request Information.
SitePath Gets the site path.
UserId Gets or sets the currently logged in user ID.
Method Description
PrivateMessageManager constructor
PrivateMessageManager(ApiAccessMode) constructor
Send(PrivateMessageData) Sends a new private message based on the supplied PrivateMessageData object. Multiple recipients can be added using PrivateMessageData.Recipients property.
Delete(Int64) Deletes a private message for the currently logged in users private message box.
MarkRead(Int64) Marks the supplied message as read for the currently logged in user. This method will not work in ApiAccessMode.Admin. A user is in charge of their own private messages.
MarkUnread(Int64) Marks the supplied message as unread for the currently logged in user. This method will not work in ApiAccessMode.Admin. A user is in charge of their own private messages.
GetItem(Int64) Retrieves a single PrivateMessageData object from the CMS.
GetList(PrivateMessageCriteria) Retrieves a list of PrivateMessageData objects based upon the supplied criteria.