Class UrlAction

The UrlAction class keeps state of the current Request throughout the rewriting process.

Inheritance

System.Object

UrlAction

Namespace: DotNetNuke.Entities.Urls

Assembly: DotNetNuke.dll

Syntax

public class UrlAction : object

Constructors

UrlAction(HttpRequest)

Initializes a new instance of the UrlAction class.

Declaration

public UrlAction(HttpRequest request)

Parameters

Type	Name	Description
HttpRequest	request

UrlAction(String, String, String)

Initializes a new instance of the UrlAction class.

Declaration

public UrlAction(string scheme, string applicationPath, string physicalPath)

Parameters

Type	Name	Description
System.String	scheme
System.String	applicationPath
System.String	physicalPath

Properties

Action

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public ActionType Action { get; set; }

Property Value

Type	Description
ActionType

ApplicationPath

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string ApplicationPath { get; set; }

Property Value

Type	Description
System.String

BrowserType

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public BrowserTypes BrowserType { get; }

Property Value

Type	Description
BrowserTypes

BypassCachedDictionary

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool BypassCachedDictionary { get; set; }

Property Value

Type	Description
System.Boolean

CanRewrite

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public StateBoolean CanRewrite { get; set; }

Property Value

Type	Description
StateBoolean

CultureCode

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
System.String

CustomParmRewrite

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool CustomParmRewrite { get; set; }

Property Value

Type	Description
System.Boolean

DebugData

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string DebugData { get; set; }

Property Value

Type	Description
System.String

DebugMessages

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public List<string> DebugMessages { get; set; }

Property Value

Type	Description
List<System.String>

dictKey

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string dictKey { get; set; }

Property Value

Type	Description
System.String

dictVal

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string dictVal { get; set; }

Property Value

Type	Description
System.String

DomainName

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string DomainName { get; set; }

Property Value

Type	Description
System.String

DoRewrite

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool DoRewrite { get; set; }

Property Value

Type	Description
System.Boolean

Ex

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public Exception Ex { get; set; }

Property Value

Type	Description
Exception

FinalUrl

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string FinalUrl { get; set; }

Property Value

Type	Description
System.String

FriendlyRewrite

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool FriendlyRewrite { get; set; }

Property Value

Type	Description
System.Boolean

HttpAlias

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string HttpAlias { get; set; }

Property Value

Type	Description
System.String

IsPhysicalResource

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool IsPhysicalResource { get; set; }

Property Value

Type	Description
System.Boolean

IsSecureConnection

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool IsSecureConnection { get; set; }

Property Value

Type	Description
System.Boolean

IsSSLOffloaded

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool IsSSLOffloaded { get; set; }

Property Value

Type	Description
System.Boolean

OriginalPath

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string OriginalPath { get; }

Property Value

Type	Description
System.String

OriginalPathNoAlias

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string OriginalPathNoAlias { get; }

Property Value

Type	Description
System.String

PhysicalPath

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string PhysicalPath { get; set; }

Property Value

Type	Description
System.String

PortalAlias

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public PortalAliasInfo PortalAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

PortalAliasMapping

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public PortalSettings.PortalAliasMapping PortalAliasMapping { get; set; }

Property Value

Type	Description
PortalSettings.PortalAliasMapping

PortalId

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
System.Int32

PrimaryAlias

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public PortalAliasInfo PrimaryAlias { get; set; }

Property Value

Type	Description
PortalAliasInfo

RawUrl

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string RawUrl { get; set; }

Property Value

Type	Description
System.String

Reason

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public RedirectReason Reason { get; set; }

Property Value

Type	Description
RedirectReason

RebuildRequested

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool RebuildRequested { get; set; }

Property Value

Type	Description
System.Boolean

RedirectAllowed

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool RedirectAllowed { get; }

Property Value

Type	Description
System.Boolean

RewritePath

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string RewritePath { get; set; }

Property Value

Type	Description
System.String

Scheme

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string Scheme { get; set; }

Property Value

Type	Description
System.String

TabId

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public int TabId { get; set; }

Property Value

Type	Description
System.Int32

UnlicensedProviderCalled

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool UnlicensedProviderCalled { get; set; }

Property Value

Type	Description
System.Boolean

UnlicensedProviderMessage

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public string UnlicensedProviderMessage { get; set; }

Property Value

Type	Description
System.String

Url

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public Uri Url { get; set; }

Property Value

Type	Description
Uri

VirtualPath

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public StateBoolean VirtualPath { get; set; }

Property Value

Type	Description
StateBoolean

Methods

AddLicensedProvider(String)

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public void AddLicensedProvider(string providerName)

Parameters

Type	Name	Description
System.String	providerName

AddLicensedProviders(List<String>)

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public void AddLicensedProviders(List<string> licensedProviders)

Parameters

Type	Name	Description
List<System.String>	licensedProviders

IsProviderLicensed(String)

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public bool IsProviderLicensed(string providerName)

Parameters

Type	Name	Description
System.String	providerName

Returns

Type	Description
System.Boolean

SetActionWithNoDowngrade(ActionType)

Sets the action value, but checks to ensure that the action is not being 'downgraded' (example: cannot set 'Redirect301' to 'CheckFor301').

Declaration

public void SetActionWithNoDowngrade(ActionType newAction)

Parameters

Type	Name	Description
ActionType	newAction

SetBrowserType(HttpRequest, HttpResponse, FriendlyUrlSettings)

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public void SetBrowserType(HttpRequest request, HttpResponse response, FriendlyUrlSettings settings)

Parameters

Type	Name	Description
HttpRequest	request
HttpResponse	response
FriendlyUrlSettings	settings

SetOriginalPath(String, FriendlyUrlSettings)

Copies the original request path to the OriginalPath variables (originalPath, originanPathNoAlias).

Declaration

public void SetOriginalPath(string path, FriendlyUrlSettings settings)

Parameters

Type	Name	Description
System.String	path
FriendlyUrlSettings	settings

SetRedirectAllowed(String, FriendlyUrlSettings)

The UrlAction class keeps state of the current Request throughout the rewriting process.

Declaration

public void SetRedirectAllowed(string path, FriendlyUrlSettings settings)

Parameters

Type	Name	Description
System.String	path
FriendlyUrlSettings	settings

Extension Methods

JsonExtensionsWeb.ToJson(Object)