Table of Contents

Class SortConverter2

Namespace
Geotab.Checkmate.Serialization
Assembly
Geotab.Checkmate.ObjectModel.dll

An abstract class used to control the conversion of objects to JSON.

public class SortConverter2 : GeotabJsonConverter2<ISort>
Inheritance
SortConverter2
Inherited Members

Constructors

SortConverter2()

public SortConverter2()

Methods

GetSortFromParams(string, SortDirection?, string?, Id?)

Gets the appropriate ISort implementation based on the provided parameters.

public static ISort GetSortFromParams(string sortBy, SortDirection? sortDirection = null, string? offset = null, Id? lastId = null)

Parameters

sortBy string

The sortBy.

sortDirection SortDirection?

The sortDirection.

offset string

The offset.

lastId Id

The lastId.

Returns

ISort

the appropriate ISort implementation

Exceptions

ArgumentException

Throws an argument exception when provided offset is not valid

Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

Read and convert the JSON to T.

public override ISort Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Parameters

reader Utf8JsonReader

The Utf8JsonReader to read from.

typeToConvert Type

The Type being converted.

options JsonSerializerOptions

The JsonSerializerOptions being used.

Returns

ISort

The value that was converted.

Remarks

A converter may throw any Exception, but should throw JsonException when the JSON is invalid.