Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityForceLogin
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
To use this class, create an instance of this object, set up the
properties, and call the Invoke method with an appropriate set
of parameters.
This class can throw exceptions, thus your code should be wrapped
within try/catch statements in order to avoid the entire page to crash.
[This is preliminary documentation and is subject to change.]
Forces an unauthorized caller to provide logon credentials and
optionally be redirected to a specific page. If the caller does not
have permission to the redirect page, an alternate page can be
supplied.
The ForceLogin class acts as the underlying engine for the Force
Login AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityForceLogin
Namespace: ContentStudio.Site.ActiveScripting.Security
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The ForceLogin type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ForceLogin |
Constructs a new instance of the ForceLogin class
|
Properties
Name | Description | |
---|---|---|
AuthenticatedRedirectDocument |
Sets or gets the ID of the document the caller should be redirected to,
if successfully authenticated. The default value is zero.
| |
AuthenticatedRedirectPresentationTemplate |
Sets or gets the ID of a presentation template to be use together with
the document indicated by the AuthenticatedRedirectDocument
property. The default value is zero (no presentation template is used).
| |
BackwardsComponentCompatibilityMode |
Sets or gets a value that indicates whether the code runs in backwards
compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.) | |
ComponentName | Gets the name of the component (Overrides ActiveScriptingBaseComponentName.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.) | |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
UnAuthenticatedRedirectDocument |
Sets or gets the ID of the document the caller is redirected to if the
caller has no browse access to the AuthenticatedRedirectDocument
document. The default value is zero
| |
UnAuthenticatedRedirectPresentationTemplate |
Sets or gets the ID of the presentation template to use together with
the document indicated by the UnAuthenticatedRedirectDocument property.
The default value is zero (no presentation template is used).
|
Methods
Name | Description | |
---|---|---|
AccessCheckForCurrentCategory |
Determines if access us granted to the current category for
the calling user.
(Inherited from SecurityBase.) | |
AccessCheckForCurrentDocument |
Determines if access us granted to the current document for
the calling user.
(Inherited from SecurityBase.) | |
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and redirects the caller according to the
specifications.
| |
ToString | (Inherited from Object.) |
Remarks
See Also