ForceLogin Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[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
SystemObject
  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
Copy
public sealed class ForceLogin : SecurityBase

The ForceLogin type exposes the following members.

Constructors
  NameDescription
Public methodForceLogin
Constructs a new instance of the ForceLogin class
Top
Properties
  NameDescription
Public propertyAuthenticatedRedirectDocument
Sets or gets the ID of the document the caller should be redirected to, if successfully authenticated. The default value is zero.
Public propertyAuthenticatedRedirectPresentationTemplate
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).
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyUnAuthenticatedRedirectDocument
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
Public propertyUnAuthenticatedRedirectPresentationTemplate
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).
Top
Methods
  NameDescription
Public methodAccessCheckForCurrentCategory
Determines if access us granted to the current category for the calling user.
(Inherited from SecurityBase.)
Public methodAccessCheckForCurrentDocument
Determines if access us granted to the current document for the calling user.
(Inherited from SecurityBase.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and redirects the caller according to the specifications.
Public methodToString (Inherited from Object.)
Top
Remarks
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.
See Also

Reference

ContentStudio.Site.ActiveScripting.Security Namespace