IContentItemCheckIn Method
|
Checks in either the page itself or the page and its descendants.
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax int CheckIn(
IEnumerable<IPublishingTarget> pubTargets,
bool recursive,
string comments = ""
)
Function CheckIn (
pubTargets As IEnumerable(Of IPublishingTarget),
recursive As Boolean,
Optional comments As String = ""
) As Integer
int CheckIn(
IEnumerable<IPublishingTarget^>^ pubTargets,
bool recursive,
String^ comments = L""
)
abstract CheckIn :
pubTargets : IEnumerable<IPublishingTarget> *
recursive : bool *
?comments : string
(* Defaults:
let _comments = defaultArg comments ""
*)
-> int
Parameters
- pubTargets
- Type: System.Collections.GenericIEnumerableIPublishingTarget
Collection of publishing targets toward which to check in this page. These publishing targets mark the page on its latest version. If not specified, no publishing target will change marking on this page. - recursive
- Type: SystemBoolean
Specifies whether to also check in the descendants of this page. - comments (Optional)
- Type: SystemString
The comments for the check in. Should be the description of the changes and their purpose.
Return Value
Type:
Int32Count of pages operated on
Remarks If the page was already checked in, the operation will continue to check in descendants and mark the page's latest version on provided publishing targets.
The current user must have the 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 Reference
[!:Ingeniux.CMS.IContentItem.CheckedInPage]