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

[This is preliminary documentation and is subject to change.]

Identifiers the user based on the Content Studio login and sets an in-memory cookie collection that contains useful user information. If the cookie already exists, this class does nothing. The cookie is a memory-based session cookie, and is destroyed when the browser is closed and it cannot be used to pass on sensitive information. This class is mainly intended for intranets (or similar) where all users are authenticated. In addition to authenticated users, anonymous users are supported. Typically, you execute this code on the start page of a web site to collect user information and have them easily accessibly in a in-memory cookie.
Inheritance Hierarchy
SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingSecurityBase
        ContentStudio.Site.ActiveScripting.SecurityLoadUserInfoCookies

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 LoadUserInfoCookies : SecurityBase

The LoadUserInfoCookies type exposes the following members.

Properties
  NameDescription
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.)
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 methodStatic memberInvoke
Invokes the component and loading an in-memory cookie collection containing user information.
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberStaticComponentName
Returns the name of the component.
Top
Remarks
LoadUserInfoCookies has no public constructor and cannot be created, nor can it be derived from since LoadUserInfoCookies is a sealed class. The cookies are accessible from a cookie name CS_UserData and contains the following cookie sub keys:
  • FullName
  • Domain
  • UserName
  • Email
  • SID
  • UserID
  • UserKey
  • LoginDate
  • PreviousLogin
  • Trustee
Cookies are very easy to read using the GetCookie(String, String)method.
Examples
The following example shows how to read the Domain cookie from the cookie collection loaded by LoadUserInfoCookies.
C#
Copy
string MyDomainCookieName = Page.GetCookie("CS_UserData", "Domain");
Visual Basic
Copy
Dim MyDomainCookieName As String = Page.GetCookie("CS_UserData", "Domain")
See Also

Reference

ContentStudio.Site.ActiveScripting.Security Namespace