ISiteFreezeContent Method
|
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax void FreezeContent(
DateTime startTime,
Nullable<DateTime> endTime,
IEnumerable<IUser> allowedUsers,
IEnumerable<IUserGroup> allowedGroups,
string message
)
Sub FreezeContent (
startTime As DateTime,
endTime As Nullable(Of DateTime),
allowedUsers As IEnumerable(Of IUser),
allowedGroups As IEnumerable(Of IUserGroup),
message As String
)
void FreezeContent(
DateTime startTime,
Nullable<DateTime> endTime,
IEnumerable<IUser^>^ allowedUsers,
IEnumerable<IUserGroup^>^ allowedGroups,
String^ message
)
abstract FreezeContent :
startTime : DateTime *
endTime : Nullable<DateTime> *
allowedUsers : IEnumerable<IUser> *
allowedGroups : IEnumerable<IUserGroup> *
message : string -> unit
Parameters
- startTime
- Type: SystemDateTime
Time to start the Content Freeze, this value can be before "Now" time, which means Content Freeze will start right away. - endTime
- Type: SystemNullableDateTime
The ending time of the Content Freeze. If null value, Content Freeze state will have to be terminated by calling
CancelContentFreeze method. - allowedUsers
- Type: System.Collections.GenericIEnumerableIUser
The list of Users that can still work with CMS during Content Freeze, besides the User
that calls this method.
If null or empty collection, only the calling User can work with CMS during Content Freeze. - allowedGroups
- Type: System.Collections.GenericIEnumerableIUserGroup
[Missing <param name="allowedGroups"/> documentation for "M:Ingeniux.CMS.ISite.FreezeContent(System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IUser},System.Collections.Generic.IEnumerable{Ingeniux.CMS.IUserGroup},System.String)"]
- message
- Type: SystemString
The message to display to blocked Users during Content Freeze.
Exceptions Exception | Condition |
---|
[!:System.SecurityException] | When a User without administrative permission trying to start a new Content Freeze, or
when a User not in the allowed Users list, trying to change a pending or ongoing Content Freeze. |
ArgumentException | When endTime is greater than startTime. |
See Also