Class Route

Namespace

Oqtane.Models

Assembly

Oqtane.Shared.dll

A route is comprised of multiple components ( some optional depending on context ) {scheme}://{hostname}/{aliaspath}/{pagepath}/*/{moduleid}/{action}/!/{urlparameters}?{query}#{fragment}

public class Route

Inheritance

object

Route

Constructors

Route()

parameterless constructor to prevent deserialization exceptions

public Route()

Route(string, string)

default constructor the route parameter can be obtained from NavigationManager.Uri on client or HttpContext.Request.GetEncodedUrl() on server the aliaspath parameter can be obtained from PageState.Alias.Path on client or TenantManager.GetAlias().Path on server

public Route(string route, string aliaspath)

Parameters

route string

aliaspath string

Properties

AbsolutePath

The absolute path for the route

public string AbsolutePath { get; set; }

Property Value

string

Action

A route may contain an action (ie. when created using EditUrl) located after the module id.

public string Action { get; set; }

Property Value

string

AliasPath

An absolute path may contain an alias path

public string AliasPath { get; set; }

Property Value

string

Authority

The host name or IP address and port number (does not include scheme or trailing slash)

public string Authority { get; set; }

Property Value

string

Fragment

A route may contain a fragment located after the # delimiter

public string Fragment { get; set; }

Property Value

string

Host

A fully qualified route contains a host name. The host name may include a port number.

public string Host { get; set; }

Property Value

string

ModuleId

A route may contain a module id (ie. when created using EditUrl) located after the module delimiter segment (/*/).

public string ModuleId { get; set; }

Property Value

string

PagePath

A absolute path may contain a page path.

public string PagePath { get; set; }

Property Value

string

PathAndQuery

The absolute path for the route including the querystring

public string PathAndQuery { get; set; }

Property Value

string

Port

A host name may contain a port number

public string Port { get; set; }

Property Value

string

Query

All querystring parameters (prefixed with a ? delimiter)

public string Query { get; set; }

Property Value

string

RootUrl

The root url contains the resource identifier for the root of an Oqtane installation ( including scheme )

public string RootUrl { get; }

Property Value

string

Scheme

A fully qualified route contains a scheme (ie. http, https )

public string Scheme { get; set; }

Property Value

string

SiteUrl

The site url contains the resource identifier for the home page of a specific Oqtane site ( including scheme and possibly an alias path )

public string SiteUrl { get; }

Property Value

string

UrlParameters

A route may contain parameters located after the url parameter delimiter segment (/!/).

public string UrlParameters { get; set; }

Property Value

string