Class DocumentAdapter

Namespace

JsonApiDotNetCore.Serialization.Request.Adapters

Assembly

JsonApiDotNetCore.dll

The entry point for validating and converting the deserialized Document from the request body into a model. The produced models are used in ASP.NET Model Binding.

public sealed class DocumentAdapter : IDocumentAdapter

Inheritance

object

DocumentAdapter

Implements

IDocumentAdapter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentAdapter(IJsonApiRequest, ITargetedFields, IDocumentInResourceOrRelationshipRequestAdapter, IDocumentInOperationsRequestAdapter)

public DocumentAdapter(IJsonApiRequest request, ITargetedFields targetedFields, IDocumentInResourceOrRelationshipRequestAdapter documentInResourceOrRelationshipRequestAdapter, IDocumentInOperationsRequestAdapter documentInOperationsRequestAdapter)

Parameters

request IJsonApiRequest

targetedFields ITargetedFields

documentInResourceOrRelationshipRequestAdapter IDocumentInResourceOrRelationshipRequestAdapter

documentInOperationsRequestAdapter IDocumentInOperationsRequestAdapter

Methods

Convert(Document)

Validates and converts the specified document. Possible return values:

• IList<OperationContainer> (operations)
• ISet<IIdentifiable> (to-many relationship, unknown relationship)
• IIdentifiable (resource, to-one relationship)
• null (to-one relationship)

public object? Convert(Document document)

Parameters

document Document

Returns

object