Class FieldSelectors

Namespace

JsonApiDotNetCore.Queries

Assembly

JsonApiDotNetCore.dll

A data structure that contains which fields (attributes and relationships) to retrieve, or empty to retrieve all. In the case of a relationship, it contains the nested query constraints.

[PublicAPI]
public sealed class FieldSelectors : Dictionary<ResourceFieldAttribute, QueryLayer?>, IDictionary<ResourceFieldAttribute, QueryLayer?>, ICollection<KeyValuePair<ResourceFieldAttribute, QueryLayer?>>, IReadOnlyDictionary<ResourceFieldAttribute, QueryLayer?>, IReadOnlyCollection<KeyValuePair<ResourceFieldAttribute, QueryLayer?>>, IEnumerable<KeyValuePair<ResourceFieldAttribute, QueryLayer?>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable

Inheritance

object

Dictionary<ResourceFieldAttribute, QueryLayer>

FieldSelectors

Implements

IDictionary<ResourceFieldAttribute, QueryLayer>

ICollection<KeyValuePair<ResourceFieldAttribute, QueryLayer>>

IReadOnlyDictionary<ResourceFieldAttribute, QueryLayer>

IReadOnlyCollection<KeyValuePair<ResourceFieldAttribute, QueryLayer>>

IEnumerable<KeyValuePair<ResourceFieldAttribute, QueryLayer>>

IDictionary

ICollection

IEnumerable

IDeserializationCallback

ISerializable

Inherited Members

Dictionary<ResourceFieldAttribute, QueryLayer>.Add(ResourceFieldAttribute, QueryLayer)

Dictionary<ResourceFieldAttribute, QueryLayer>.Clear()

Dictionary<ResourceFieldAttribute, QueryLayer>.ContainsKey(ResourceFieldAttribute)

Dictionary<ResourceFieldAttribute, QueryLayer>.ContainsValue(QueryLayer)

Dictionary<ResourceFieldAttribute, QueryLayer>.EnsureCapacity(int)

Dictionary<ResourceFieldAttribute, QueryLayer>.GetEnumerator()

Dictionary<ResourceFieldAttribute, QueryLayer>.OnDeserialization(object)

Dictionary<ResourceFieldAttribute, QueryLayer>.Remove(ResourceFieldAttribute)

Dictionary<ResourceFieldAttribute, QueryLayer>.Remove(ResourceFieldAttribute, out QueryLayer)

Dictionary<ResourceFieldAttribute, QueryLayer>.TrimExcess()

Dictionary<ResourceFieldAttribute, QueryLayer>.TrimExcess(int)

Dictionary<ResourceFieldAttribute, QueryLayer>.TryAdd(ResourceFieldAttribute, QueryLayer)

Dictionary<ResourceFieldAttribute, QueryLayer>.TryGetValue(ResourceFieldAttribute, out QueryLayer)

Dictionary<ResourceFieldAttribute, QueryLayer>.Comparer

Dictionary<ResourceFieldAttribute, QueryLayer>.Count

Dictionary<ResourceFieldAttribute, QueryLayer>.this[ResourceFieldAttribute]

Dictionary<ResourceFieldAttribute, QueryLayer>.Keys

Dictionary<ResourceFieldAttribute, QueryLayer>.Values

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

AsyncCollectionExtensions.AddRangeAsync<T>(ICollection<T>, IAsyncEnumerable<T>, CancellationToken)

Properties

ContainsOnlyRelationships

public bool ContainsOnlyRelationships { get; }

Property Value

bool

ContainsReadOnlyAttribute

public bool ContainsReadOnlyAttribute { get; }

Property Value

bool

IsEmpty

public bool IsEmpty { get; }

Property Value

bool

Methods

ContainsField(ResourceFieldAttribute)

public bool ContainsField(ResourceFieldAttribute field)

Parameters

field ResourceFieldAttribute

Returns

bool

IncludeAttribute(AttrAttribute)

public void IncludeAttribute(AttrAttribute attribute)

Parameters

attribute AttrAttribute

IncludeAttributes(IEnumerable<AttrAttribute>)

public void IncludeAttributes(IEnumerable<AttrAttribute> attributes)

Parameters

attributes IEnumerable<AttrAttribute>

IncludeRelationship(RelationshipAttribute, QueryLayer)

public void IncludeRelationship(RelationshipAttribute relationship, QueryLayer queryLayer)

Parameters

relationship RelationshipAttribute

queryLayer QueryLayer

RemoveAttributes()

public void RemoveAttributes()