Table of Contents

Class TimeSpanConverter

Namespace
Breeze.Core
Assembly
Breeze.Core.dll

Serializes TimeSpan as an XML Schema duration - "PT2H30M" - which is the form the Breeze client reads and writes.

public class TimeSpanConverter : JsonConverter
Inheritance
JsonConverter
TimeSpanConverter
Inherited Members
JsonConverter.CanRead
JsonConverter.CanWrite

Methods

CanConvert(Type)

Handles TimeSpan and TimeSpan?.

public override bool CanConvert(Type objectType)

Parameters

objectType Type

The type being considered.

Returns

bool

True for TimeSpan and its nullable form.

ReadJson(JsonReader, Type, object?, JsonSerializer)

Read a TimeSpan from an XML Schema duration string.

public override object? ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer)

Parameters

reader JsonReader

The reader positioned at the value.

objectType Type

The target type.

existingValue object

Any value already present. Unused.

serializer JsonSerializer

The serializer in use.

Returns

object

The parsed TimeSpan, or null for a JSON null.

Exceptions

FormatException

The string is not a valid duration.

WriteJson(JsonWriter, object?, JsonSerializer)

Write a TimeSpan as an XML Schema duration string.

public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)

Parameters

writer JsonWriter

The writer to write to.

value object

The TimeSpan. Json.NET handles nulls itself and never passes one here.

serializer JsonSerializer

The serializer in use.

See Also