ReadEndpoint

public protocol ReadEndpoint : AuthEndpoint

A special AuthEndpoint used to provide a common interface for endpoints which provide access to modifiers that are applcable for Database read requests

  • children(_:) Extension method

    A modifier used to return items related to a component as defined by a given KeyPath.

    Declaration

    Swift

    public func children<M: CorvusModel>(
    _ path: ChildrenModifier<Self, M>.ChildrenPath
) -> ChildrenModifier<Self, M>

    Parameters

    with

    A KeyPath to the related property.

    Return Value

    An instance of a ChildrenModifier with the supplied KeyPath to the relationship.

  • filter(_:) Extension method

    A modifier used to filter the values returned by a component using a passed in ModelValueFilter.

    Declaration

    Swift

    public func filter(
    _ filter: FilterModifier<Self>.Filter
) -> FilterModifier<Self>

    Parameters

    filter

    A ModelValueFilter to filter values by.

    Return Value

    An instance of a FilterModifier with the supplied filter.

  • operationType Extension method

    Declaration

    Swift

    public var operationType: OperationType { get }