RawDefinitionOptions Plugin Supplementary Type

Former Member — Fri, 13 May 2022 19:24:20 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:24:20

Provides additional options when defining a a raw url.

RawDefinitionOptions is defined in the Telligent.Evolution.Extensibility.Urls.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

class RawDefinitionOptions
{
	string Description { get; set;  }
	Func<string> DescriptionFunction { get; set;  }
	bool EnableRemoteProxying { get; set;  }
	bool ForceLowercaseUrl { get; set;  }
	Action<[[PageContext Plugin Supplementary Type|PageContext]]> ParseContext { get; set;  }
	Func<Guid,string> SampleUrlFunction { get; set;  }
	string Title { get; set;  }
	Func<string> TitleFunction { get; set;  }
	Action<[[PageContext Plugin Supplementary Type|PageContext]],[[IUrlAccessController Plugin Supplementary Type|IUrlAccessController]]> Validate { get; set;  }
	Func<[[PageContext Plugin Supplementary Type|PageContext]],[[IUrlAccessController Plugin Supplementary Type|IUrlAccessController]],Task> ValidateAsync { get; set;  }
}

Properties

Name	Type	Description
Description	`string`	A description that describes the purpose and function of the url.
DescriptionFunction	`Func<string>`	A function that returns a description that describes the purpose and function of the url. Overrides Description.
EnableRemoteProxying	`bool`	Makes this url proxied via Remote Studio Widgets
ForceLowercaseUrl	`bool`	forces the url to be lowercase when rendered. The default is true.
ParseContext	`Action<[[PageContext Plugin Supplementary Type\|PageContext]]>`	Allows for the parsing of url token information that can be added to the page context.
SampleUrlFunction	`Func<Guid,string>`	A function that takes the theme-specific application ID and provides a URL to view the route.
Title	`string`	Default title for the url.
TitleFunction	`Func<string>`	A function that returns the default title for the url. Overrides Title.
Validate	`Action<[[PageContext Plugin Supplementary Type\|PageContext]],[[IUrlAccessController Plugin Supplementary Type\|IUrlAccessController]]>`	Called after a context is parsed. Allows for redirects and access checking before a page is served.
ValidateAsync	`Func<[[PageContext Plugin Supplementary Type\|PageContext]],[[IUrlAccessController Plugin Supplementary Type\|IUrlAccessController]],Task>`	Called after a context is parsed. Allows for redirects and access checking before a page is served.