Class SeltzrOptions<TModel, TUser>

Options for a specific Seltzr route

Inheritance

Object

SeltzrOptions<TModel, TUser>

Namespace: Seltzr.Options

Assembly: Seltzr.dll

Syntax

C#

Copy

public class SeltzrOptions<TModel, TUser>
    where TModel : class where TUser : class

Type Parameters

TModel

The type of model this route handles

TUser

The type of authenticated user context

Properties

AuthProviders

Gets or sets a list of providers available to authenticate the request

C#

Copy

public List<IAuthProvider<TModel, TUser>> AuthProviders { get; set; }

Property Value

List<IAuthProvider<TModel, TUser>>

BodyParsers

Gets or sets the parsers available to parse a request body

C#

Copy

public List<IBodyParser<TModel>> BodyParsers { get; set; }

Property Value

List<IBodyParser<TModel>>

Conditions

Gets or sets a list of conditions that the request must meet

C#

Copy

public List<ICondition<TModel, TUser>> Conditions { get; set; }

Property Value

List<ICondition<TModel, TUser>>

ExceptionHandlers

Gets or sets the list of exception handlers for this route

C#

Copy

public List<IExceptionHandler> ExceptionHandlers { get; set; }

Property Value

List<IExceptionHandler>

Filters

Gets or sets a list of filters to pare down the dataset

C#

Copy

public List<IFilter<TModel, TUser>> Filters { get; set; }

Property Value

List<IFilter<TModel, TUser>>

FormattingOptions

Gets or sets any options for the ResultWriter

C#

Copy

public FormattingOptions FormattingOptions { get; set; }

Property Value

FormattingOptions

ModelProvider

Gets or sets the provider for the API's models

C#

Copy

public IModelProvider<TModel, TUser> ModelProvider { get; set; }

Property Value

IModelProvider<TModel, TUser>

Operation

Gets or sets the operation to perform on the dataset, if any

C#

Copy

public IOperation<TModel, TUser> Operation { get; set; }

Property Value

IOperation<TModel, TUser>

ParserOptions

Gets or sets the options for parsing request bodies

C#

Copy

public ParserOptions ParserOptions { get; set; }

Property Value

ParserOptions

PostOpActions

Gets or sets the list of post-operation actions for this route

C#

Copy

public List<IPostOpAction<TModel, TUser>> PostOpActions { get; set; }

Property Value

List<IPostOpAction<TModel, TUser>>

PreOpActions

Gets or sets the list of pre-operation actions for this route

C#

Copy

public List<IPreOpAction<TModel, TUser>> PreOpActions { get; set; }

Property Value

List<IPreOpAction<TModel, TUser>>

RequestMethods

Gets or sets the request methods these options match

C#

Copy

public HashSet<string> RequestMethods { get; set; }

Property Value

HashSet<String>

ResponseType

Gets or sets the type of Response<TModel> to wrap responses in

C#

Copy

public Type ResponseType { get; set; }

Property Value

Type

ResultWriter

Gets or sets the result writer for this route

C#

Copy

public IResultWriter<TModel, TUser> ResultWriter { get; set; }

Property Value

IResultWriter<TModel, TUser>

RoutePattern

Gets or sets the pattern of the route that these options match with

C#

Copy

public string RoutePattern { get; set; }

Property Value

String

Methods

Copy()

Makes a copy of this options object and returns it

C#

Copy

public SeltzrOptions<TModel, TUser> Copy()

Returns

SeltzrOptions<TModel, TUser>

The copy of this SeltzrOptions<TModel, TUser>