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

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

Redirects the caller to another page depending on the IP-address of the client. Up to 15 IP addresses can be defined. The IPAddressAccessRestrictions class acts as the underlying engine for the IP address access restrictions AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingSecurityBase
        ContentStudio.Site.ActiveScripting.SecurityIPAddressAccessRestrictions

Namespace: ContentStudio.Site.ActiveScripting.Security
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class IPAddressAccessRestrictions : SecurityBase

The IPAddressAccessRestrictions type exposes the following members.

Constructors

  NameDescription
Public methodIPAddressAccessRestrictions
Constructs a new instance of the IPAddressAccessRestrictionsDev class.
Top
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 propertyDenyID
Sets or gets the ID of the page to show if access is denied. The default value is an empty string.
Public propertyDenyPTID
Sets or gets the ID of the presentation template to use with the DenyID page. The default value is an empty string.
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 propertyGrantID
Sets or gets the ID of the page to show if access is granted. The default value is an empty string.
Public propertyGrantIPAddresses
Sets or gets a value indicting if the supplied IP addresses should be granted access. The default value is true. If it is set to false, the supplied IP addresses are denied access.
Public propertyGrantPTID
Sets or gets the ID of the presentation template to use with the GrantID page. The default value is an empty string.
Public propertyIPAddress1
Sets or gets the value of IP address 1. The default value is an empty string.
Public propertyIPAddress10
Sets or gets the value of IP address 10. The default value is an empty string.
Public propertyIPAddress11
Sets or gets the value of IP address 11. The default value is an empty string.
Public propertyIPAddress12
Sets or gets the value of IP address 12. The default value is an empty string.
Public propertyIPAddress13
Sets or gets the value of IP address 13. The default value is an empty string.
Public propertyIPAddress14
Sets or gets the value of IP address 14. The default value is an empty string.
Public propertyIPAddress15
Sets or gets the value of IP address 15. The default value is an empty string.
Public propertyIPAddress2
Sets or gets the value of IP address 2. The default value is an empty string.
Public propertyIPAddress3
Sets or gets the value of IP address 3. The default value is an empty string.
Public propertyIPAddress4
Sets or gets the value of IP address 4. The default value is an empty string.
Public propertyIPAddress5
Sets or gets the value of IP address5. The default value is an empty string.
Public propertyIPAddress6
Sets or gets the value of IP address 6. The default value is an empty string.
Public propertyIPAddress7
Sets or gets the value of IP address 7. The default value is an empty string.
Public propertyIPAddress8
Sets or gets the value of IP address 8. The default value is an empty string. .
Public propertyIPAddress9
Sets or gets the value of IP address 9. The default value is an empty string.
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.
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