Class SeltzrOptionsBuilderExtensions
Extension methods for the SeltzrOptionsBuilder<TModel, TUser> class.
Namespace: Seltzr.Extensions
Assembly: Seltzr.dll
Syntax
public static class SeltzrOptionsBuilderExtensions
Methods
Auth<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, Func<IApiContext<TModel, NoUser>, Boolean>)
Adds an auth provider to this route that authenticates with a delegate
public static SeltzrOptionsBuilder<TModel, NoUser> Auth<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, Func<IApiContext<TModel, NoUser>, bool> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
handler
Func<IApiContext<TModel, NoUser>, Boolean>
The handler which, when given the API request context, will return true if the credentials are valid and false otherwise
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthAsync<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, Func<IApiContext<TModel, NoUser>, Task<Boolean>>)
Adds an auth provider to this route that authenticates with a delegate
public static SeltzrOptionsBuilder<TModel, NoUser> AuthAsync<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, Func<IApiContext<TModel, NoUser>, Task<bool>> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
handler
Func<IApiContext<TModel, NoUser>, Task<Boolean>>
The handler which, when given the API request context, will return true if the credentials are valid and false otherwise
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthBasic<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, Func<String, String, Boolean>)
Adds an auth provider to this route that authenticates with basic auth
public static SeltzrOptionsBuilder<TModel, NoUser> AuthBasic<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, Func<string, string, bool> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthBasic<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, String)
Adds an auth provider to this route that authenticates with basic auth
public static SeltzrOptionsBuilder<TModel, NoUser> AuthBasic<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string username, string password)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
username
String
The expected value of the username. Authorization will succeed if both this and password
value
equals
the actual values and fail otherwise
password
String
The expected value of the password. Authorization will succeed if both this and username
value
equals
the actual values and fail otherwise
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthBasicAsync<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, Func<String, String, Task<Boolean>>)
Adds an auth provider to this route that authenticates with basic auth
public static SeltzrOptionsBuilder<TModel, NoUser> AuthBasicAsync<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, Func<string, string, Task<bool>> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthHeader<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, Func<String, Boolean>)
Adds an auth provider to this route that authenticates with a header
public static SeltzrOptionsBuilder<TModel, NoUser> AuthHeader<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, Func<string, bool> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the header to authenticate with
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthHeader<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, String)
Adds an auth provider to this route that authenticates with a header
public static SeltzrOptionsBuilder<TModel, NoUser> AuthHeader<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, string value)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the header to authenticate with
value
String
The expected value of the parameter. Authorization will succeed if the parameter value equals
value
and fail otherwise
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthHeaderAsync<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, Func<String, Task<Boolean>>)
Adds an auth provider to this route that authenticates with a header
public static SeltzrOptionsBuilder<TModel, NoUser> AuthHeaderAsync<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, Func<string, Task<bool>> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the header to authenticate with
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthQuery<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, Func<String, Boolean>)
Adds an auth provider to this route that authenticates with a query parameter
public static SeltzrOptionsBuilder<TModel, NoUser> AuthQuery<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, Func<string, bool> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the parameter to authenticate with
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthQuery<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, String)
Adds an auth provider to this route that authenticates with a query parameter
public static SeltzrOptionsBuilder<TModel, NoUser> AuthQuery<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, string value)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the parameter to authenticate with
value
String
The expected value of the parameter. Authorization will succeed if the parameter value equals
value
and fail otherwise
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for
AuthQueryAsync<TModel>(SeltzrOptionsBuilder<TModel, NoUser>, String, Func<String, Task<Boolean>>)
Adds an auth provider to this route that authenticates with a query parameter
public static SeltzrOptionsBuilder<TModel, NoUser> AuthQueryAsync<TModel>(this SeltzrOptionsBuilder<TModel, NoUser> builder, string parameterName, Func<string, Task<bool>> handler)
where TModel : class
Parameters
builder
SeltzrOptionsBuilder<TModel, NoUser>
The options builder to perform the operation on
parameterName
String
The name of the parameter to authenticate with
Returns
SeltzrOptionsBuilder<TModel, NoUser>
This SeltzrOptionsBuilder<TModel, TUser> object, for chaining
Type Parameters
TModel
The model type that the API is being built for