Interface IResultWriter<TModel, TUser>
Writer for API results
Namespace: Seltzr.Results
Assembly: Seltzr.dll
Syntax
C#
public interface IResultWriter<TModel, in TUser>
where TModel : class where TUser : class
Type Parameters
TModel
The type of model to format
TUser
The type of authenticated user context
Methods
Gets whether or not this IResultWriter<TModel, TUser> can write a result for the given request
C#
Task<bool> CanWriteAsync(HttpRequest request)
Parameters
request
HttpRequest
The request to test if a result can be written for it
Returns
true if a result can be written for request
, false otherwise
|
Improve this Doc
View Source
WriteResultAsync(IApiContext<TModel, TUser>, IEnumerable<TModel>, FormattingOptions)
Formats the API result
C#
Task WriteResultAsync(IApiContext<TModel, TUser> context, IEnumerable<TModel> data, FormattingOptions options)
Parameters
context
IApiContext<TModel, TUser>
The current API context
data
IEnumerable<TModel>
The dataset to format
options
FormattingOptions
Options for formatting the result
Returns
When the result has been sent