Class EndpointOptions

Namespace

The.Web

Assembly

Instagile.Web.dll

Configuration for MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool)

public sealed class EndpointOptions

Inheritance

object

EndpointOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EndpointOptions(bool)

Configuration for MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool)

public EndpointOptions(bool enableAllRoutesByDefault = true)

Parameters

enableAllRoutesByDefault bool

Properties

AllowAnonymousAccess

Permit unauthenticated access to public data like anonymous RPCs and public documents.

public bool AllowAnonymousAccess { get; set; }

Property Value

bool

EndpointControllerName

Set the name of the controller-style RPC routes for compatibility with existing customisations.

[Obsolete("Will be removed eventually. Change clients to call '_the'-prefixed routes.")]
public string EndpointControllerName { get; set; }

Property Value

string

IncludeAccountRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will map routes for logging in.

public bool IncludeAccountRoutes { get; set; }

Property Value

bool

IncludeControllerStyleRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will add extra routes for backwards compatibility with controllers.

[Obsolete("Will be removed eventually. Change clients to call '_the'-prefixed routes.")]
public bool IncludeControllerStyleRoutes { get; set; }

Property Value

bool

IncludeDocumentRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will map routes for reading files and images.

public bool IncludeDocumentRoutes { get; set; }

Property Value

bool

IncludeRPCRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will map routes for framework RPCs.

public bool IncludeRPCRoutes { get; set; }

Property Value

bool

IncludeStatusRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will map routes for retrieving version information.

public bool IncludeStatusRoutes { get; set; }

Property Value

bool

IncludeUpdateRoutes

If true, MapTheFramework(IEndpointRouteBuilder, Action<EndpointOptions>?, bool) will map routes for retrieving updates for a WPF application.

public bool IncludeUpdateRoutes { get; set; }

Property Value

bool

RequireRPCAuthorisationPolicies

Require each of the named authorisation policies to invoke RPCs.

public List<string> RequireRPCAuthorisationPolicies { get; }

Property Value

List<string>

UpdateControllerName

Set the name of the controller-style update routes for compatibility with existing customisations.

[Obsolete("Will be removed eventually. Change clients to call '_the'-prefixed routes.")]
public string UpdateControllerName { get; set; }

Property Value

string