Class ResponseModelAdapter

Namespace

JsonApiDotNetCore.Serialization.Response

Assembly

JsonApiDotNetCore.dll

Converts the produced model from an ASP.NET controller action into a Document, ready to be serialized as the response body.

[PublicAPI]
public class ResponseModelAdapter : IResponseModelAdapter

Inheritance

object

ResponseModelAdapter

Implements

IResponseModelAdapter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ResponseModelAdapter(IJsonApiRequest, IJsonApiOptions, ILinkBuilder, IMetaBuilder, IResourceDefinitionAccessor, IEvaluatedIncludeCache, ISparseFieldSetCache, IRequestQueryStringAccessor)

public ResponseModelAdapter(IJsonApiRequest request, IJsonApiOptions options, ILinkBuilder linkBuilder, IMetaBuilder metaBuilder, IResourceDefinitionAccessor resourceDefinitionAccessor, IEvaluatedIncludeCache evaluatedIncludeCache, ISparseFieldSetCache sparseFieldSetCache, IRequestQueryStringAccessor requestQueryStringAccessor)

Parameters

request IJsonApiRequest

options IJsonApiOptions

linkBuilder ILinkBuilder

metaBuilder IMetaBuilder

resourceDefinitionAccessor IResourceDefinitionAccessor

evaluatedIncludeCache IEvaluatedIncludeCache

sparseFieldSetCache ISparseFieldSetCache

requestQueryStringAccessor IRequestQueryStringAccessor

Methods

Convert(object?)

Validates and converts the specified model. Supported model types:

• IEnumerable<IIdentifiable>
• IIdentifiable
• null
• IEnumerable<OperationContainer?>
• IEnumerable<ErrorObject>
• ErrorObject

public Document Convert(object? model)

Parameters

model object

Returns

Document

ConvertAttributes(IIdentifiable, ResourceType, IImmutableSet<ResourceFieldAttribute>)

protected virtual IDictionary<string, object?>? ConvertAttributes(IIdentifiable resource, ResourceType resourceType, IImmutableSet<ResourceFieldAttribute> fieldSet)

Parameters

resource IIdentifiable

resourceType ResourceType

fieldSet IImmutableSet<ResourceFieldAttribute>

Returns

IDictionary<string, object>

ConvertOperation(OperationContainer?, IImmutableSet<IncludeElementExpression>)

protected virtual AtomicResultObject ConvertOperation(OperationContainer? operation, IImmutableSet<IncludeElementExpression> includeElements)

Parameters

operation OperationContainer

includeElements IImmutableSet<IncludeElementExpression>

Returns

AtomicResultObject

ConvertResource(IIdentifiable, ResourceType, EndpointKind)

protected virtual ResourceObject ConvertResource(IIdentifiable resource, ResourceType resourceType, EndpointKind kind)

Parameters

resource IIdentifiable

resourceType ResourceType

kind EndpointKind

Returns

ResourceObject

GetApiObject()

protected virtual JsonApiObject? GetApiObject()

Returns

JsonApiObject