Click or drag to resize

IContentItemCheckInOnProfile Method


Checks in either the page itself or the page and its descendants toward the Publishing Targets included in the Publishing Profile.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
void CheckInOnProfile(
	IPublishingProfile profile,
	bool recursive,
	string comments = ""
)

Parameters

profile
Type: Ingeniux.CMSIPublishingProfile
The publishing profile that includes the publishing targets toward which to check in the page. If not specified, no publishing target will mark the page on its latest version.
recursive
Type: SystemBoolean
Specifies whether to also check in the descendants of this Page together.
comments (Optional)
Type: SystemString
The comments for the check in. Should be the description of the changes and their purpose.
Remarks

If the page was already checked in, the operation will continue to check in descendants and mark the page's latest version on the publishing targets included in the publishing profile.

The current user must have permission to check in and check out pages. Otherwise, an error will be thrown.

The current user must have Full Access to this page. Otherwise, an error will be thrown.

If the page is not assigned to the current user and the current user doesn't have to right to check in other user's pages, an error will be thrown.

If the page contains required Elements that don't have values filled in, an error will be thrown.

Two events are fired during execution of this method: BeforePageCheckIn and AfterPageCheckIn.

See Also