PageCommandsServices Class

Provides functionality to work with page content.

Inheritance Hierarchy

SystemObject
  CMSServicesBase
    CMSContentServiceBase
      IngeniuxCMServicePageCommandsServices

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.169

Syntax

C++

Copy

[ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)]
[AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class PageCommandsServices : CMSContentServiceBase

<ServiceBehaviorAttribute(IncludeExceptionDetailInFaults := true)>
<AspNetCompatibilityRequirementsAttribute(RequirementsMode := AspNetCompatibilityRequirementsMode.Allowed)>
Public Class PageCommandsServices
	Inherits CMSContentServiceBase

[ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)]
[AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode::Allowed)]
public ref class PageCommandsServices : public CMSContentServiceBase

[<ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)>]
[<AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)>]
type PageCommandsServices =  
    class
        inherit CMSContentServiceBase
    end

The PageCommandsServices type exposes the following members.

Constructors

	Name	Description
	PageCommandsServices	Initializes a new instance of the PageCommandsServices class

Top

Methods

	Name	Description
	AddCloneMap	Adds a new Lingual Map between 2 pages.
	AddToWorkflow	Adds the given Pages to Workflow, with specified Workflow Definition.
	Advance	Advances a Page in Workflow via specified transition.
	Assign	Assigns a list of Pages to specified User or Group
	CheckIn	Checks in specified Pages, which publish-marking information
	CheckOut	Checks out a list of Pages to current user
	Claim	Assigns a Page that is currently assigned to a User Group that current User belongs to.
	Delete	Deletes a list of Pages
	GetAllSchemas	Retrieves a list of simplified inform entries on all Schemas of the site
	GetContentItemAllowed
	GetContentItemDescendantCount	Retrieves the count of descendants of a particular page or asset folder
	GetContentItemUsageReport	Retrieves all references to other content items, of given content item
	GetContentItemUsageSummary	Retrieves count of internal references of specific page
	GetEmbedDummyData	Retrieves dummy Page data based on given Schema. This operation is used to find out what the Page created from a Schema be like, without creating an actual Page.
	GetFullLingualMaps	Retrieves the complete lingual map information for the specified page
	GetGlobalVariables	Retrieves the collection of names of Global Variables. Divided to Static variables and Dynamic variables
	GetPageData	Retrieves a Page's detailed data.
	GetPageTranslationData	Retrieves a clone Page's page data together with the page data of its master Page.
	GetPageVersion	Retrieves the content of a Page's specific version, also specifies whether to produce diffing results.
	GetVersionHistory	Retrieve the list of version summary information the given Page has
	GetVersionHistoryPaged
	MassAdvance	Advances multiple Pages that are at the Workstates that have the specified transition available.
	QuickSearchContentItems	Searches for pages, assets, asset folders by the initial characters in their names
	QuickSearchPage	Searches Pages by the initial characters in their names
	RemoveCloneMap	Removes a Lingual Map which has the Clone Page's Id matching given clone Id.
	RemoveFromWorkflow	Removes Pages from their current Workflow
	Rename	Renames a Page
	RevertSchema	Reverts the page to its original creation schema. Only applies to pages with presentation that are origin pages of their schemas.
	Rollback	Rolls back the Page to its previous version. After rolling back, Page will keep it current version number, but its content was changed to the previous version's content; and it will be in checked in state.
	Save	Saves a Page with updated content.
	SaveNewSchemaFromPage	Creates a new Schema based on given Page's content, only applies to Page's with presentations. If Page has no presentations, returns error status. There are 2 Schemas with the same Root name allowed, one with Presentation, one without. Once this operation is carried out once on a Schema, it cannot be called again on the Pages with the new schema. After the new Schema is saved, the Page used to create this Schema will be used the new schema instead of its previous one. All other Pages using the previous schema will not be affected.
	SavePartial	Selectively update specific elements and/or attribute on a page
	SendMail	Sends an email out, using the Ingeniux CMS site mail settings. The email message will be plain text.
	SerializeOnCheckIn	Sets the SerializeOnCheckIn property on the page. It will generate an xID.xml file in the v9 xml root on check in.
	UndoCheckout	Abandons all changes made in the Check out version of Page, change Page state back to Checked in.
	UpdatePageSchema	Updates the Schema of the Page based on current Page content, only applies to Page's with presentations. If Page has no presentations, returns error status.

Top

Reference

IngeniuxCMService Namespace