SystemTextJsonInputFormatter Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.Formatters

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: SystemTextJsonInputFormatter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A TextInputFormatter for JSON content that uses JsonSerializer.

public ref class SystemTextJsonInputFormatter : Microsoft::AspNetCore::Mvc::Formatters::TextInputFormatter, Microsoft::AspNetCore::Mvc::Formatters::IInputFormatterExceptionPolicy

public class SystemTextJsonInputFormatter : Microsoft.AspNetCore.Mvc.Formatters.TextInputFormatter, Microsoft.AspNetCore.Mvc.Formatters.IInputFormatterExceptionPolicy

type SystemTextJsonInputFormatter = class
    inherit TextInputFormatter
    interface IInputFormatterExceptionPolicy

Public Class SystemTextJsonInputFormatter
Inherits TextInputFormatter
Implements IInputFormatterExceptionPolicy

Inheritance: Object

InputFormatter

TextInputFormatter
SystemTextJsonInputFormatter

Implements: IInputFormatterExceptionPolicy

Constructors

SystemTextJsonInputFormatter(JsonOptions, ILogger<SystemTextJsonInputFormatter>)

Initializes a new instance of SystemTextJsonInputFormatter.

Properties

SerializerOptions	Gets the JsonSerializerOptions used to configure the JsonSerializer.
SupportedEncodings	Gets the mutable collection of character encodings supported by this TextInputFormatter. The encodings are used when reading the data. (Inherited from TextInputFormatter)
SupportedMediaTypes	Gets the mutable collection of media type elements supported by this InputFormatter. (Inherited from InputFormatter)

Methods

CanRead(InputFormatterContext)	Determines whether this IInputFormatter can deserialize an object of the `context`'s ModelType. (Inherited from InputFormatter)
CanReadType(Type)	Determines whether this InputFormatter can deserialize an object of the given `type`. (Inherited from InputFormatter)
GetDefaultValueForType(Type)	Gets the default value for a given type. Used to return a default value when the body contains no content. (Inherited from InputFormatter)
GetSupportedContentTypes(String, Type)	Gets a filtered list of content types which are supported by the IInputFormatter for the `objectType` and `contentType`. (Inherited from InputFormatter)
ReadAsync(InputFormatterContext)	Reads an object from the request body. (Inherited from InputFormatter)
ReadRequestBodyAsync(InputFormatterContext, Encoding)	Reads an object from the request body.
ReadRequestBodyAsync(InputFormatterContext)	Reads an object from the request body. (Inherited from TextInputFormatter)
SelectCharacterEncoding(InputFormatterContext)	Returns an Encoding based on `context`'s character set. (Inherited from TextInputFormatter)

Explicit Interface Implementations

IInputFormatterExceptionPolicy.ExceptionPolicy

Gets the flag to indicate if the body model binder should handle all exceptions. If an exception is handled, the body model binder converts the exception into model state errors, else the exception is allowed to propagate.

Applies to

Share via