Ektron.Cms.Framework.Settings.CmsMessageManager
Api class for managing Messages in the CMS.
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.
|
| MessageService |
Gets instance to ICmsMessage.
|
| RequestInformation |
Gets the current Request Information.
|
| SitePath |
Gets the site path.
|
| UserId |
Gets or sets the currently logged in user ID.
|
| Method |
Description |
| CmsMessageManager |
Constructor
|
| CmsMessageManager(ApiAccessMode) |
|
| Add(CmsMessageData) |
Adds a new message based on information in an CmsMessageData object.
message.Id will be populated with the newly created ID.
|
| Update(CmsMessageData) |
Updates an existing message in the CMS.
|
| Delete(Int64) |
Deletes a message in the CMS.
|
| GetItem(Int64) |
Retrieves a single CmsMessageData object from the CMS in the current language.
|
| GetItemCollection(Int64) |
Gets a single message from the CMS in all available languages.
|
| GetDefaultItemByType(Int64) |
Gets the default message for a given message type in the CMS.
All available languages of the message are returned as part of the CmsMessageDataCollection.
|
| GetList(CmsMessageCriteria) |
Retrieves a list of CmsMessageData objects based upon the supplied criteria.
|