Class PhoneNumberJsonConverter

Namespace

Vonage.Common.Serialization

Assembly

Vonage.dll

Represents a custom converter from PhoneNumber to Json.

public class PhoneNumberJsonConverter : JsonConverter<PhoneNumber>

Inheritance

object

JsonConverter

JsonConverter<PhoneNumber>

PhoneNumberJsonConverter

Inherited Members

JsonConverter<PhoneNumber>.CanConvert(Type)

JsonConverter<PhoneNumber>.ReadAsPropertyName(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<PhoneNumber>.WriteAsPropertyName(Utf8JsonWriter, PhoneNumber, JsonSerializerOptions)

JsonConverter<PhoneNumber>.HandleNull

JsonConverter<PhoneNumber>.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

// Register the converter in serializer options
var options = new JsonSerializerOptions();
options.Converters.Add(new PhoneNumberJsonConverter());

// The converter handles serialization/deserialization of PhoneNumber
string json = JsonSerializer.Serialize(new PhoneNumber("14155552671"), options);
// Produces: "14155552671"

Methods

Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

Reads and converts the JSON to type PhoneNumber.

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

Parameters

reader Utf8JsonReader

The reader.

typeToConvert Type

The type to convert.

options JsonSerializerOptions

An object that specifies serialization options to use.

Returns

PhoneNumber

The converted value.

Write(Utf8JsonWriter, PhoneNumber, JsonSerializerOptions)

Writes a specified value as JSON.

public override void Write(Utf8JsonWriter writer, PhoneNumber value, JsonSerializerOptions options)

Parameters

writer Utf8JsonWriter

The writer to write to.

value PhoneNumber

The value to convert to JSON.

options JsonSerializerOptions

An object that specifies serialization options to use.