Interface ILinkBuilder

Namespace

JsonApiDotNetCore.Serialization.Response

Assembly

JsonApiDotNetCore.dll

Builds resource object links and relationship object links.

public interface ILinkBuilder

Methods

GetRelationshipLinks(RelationshipAttribute, IIdentifiable)

Builds the links object for a relationship inside a returned resource.

RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)

Parameters

relationship RelationshipAttribute

leftResource IIdentifiable

Returns

RelationshipLinks

GetResourceLinks(ResourceType, IIdentifiable)

Builds the links object for a returned resource (primary or included).

ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource)

Parameters

resourceType ResourceType

resource IIdentifiable

Returns

ResourceLinks

GetTopLevelLinks()

Builds the links object that is included in the top-level of the document.

TopLevelLinks? GetTopLevelLinks()

Returns

TopLevelLinks