# HierarchicalKeyJsonConverter Methods

[Type overview](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.messaging.hierarchicalkey.hierarchicalkeyjsonconverter/)

## Read(Utf8JsonReader, Type, JsonSerializerOptions) {#read-ref-system-text-json-utf8jsonreader-system-type-system-text-json-jsonserial-6f54ba59}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.messaging.hierarchicalkey.hierarchicalkeyjsonconverter/methods/read-ref-system-text-json-utf8jsonreader-system-type-system-text-json-jsonserial-6f54ba59/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Messaging/HierarchicalKey.cs#L44-L47)

```csharp
public override HierarchicalKey Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
```

Reads and converts the JSON to type `T`.

### Parameters

- `reader` (`Utf8JsonReader`): The reader.
- `typeToConvert` (`Type`): The type to convert.
- `options` (`JsonSerializerOptions`): An object that specifies serialization options to use.

### Returns

The converted value.

## ReadAsPropertyName(Utf8JsonReader, Type, JsonSerializerOptions) {#readaspropertyname-ref-system-text-json-utf8jsonreader-system-type-system-text-j-e493b74f}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.messaging.hierarchicalkey.hierarchicalkeyjsonconverter/methods/readaspropertyname-ref-system-text-json-utf8jsonreader-system-type-system-text-j-e493b74f/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Messaging/HierarchicalKey.cs#L59)

```csharp
public override HierarchicalKey ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
```

Reads a dictionary key from a JSON property name.

### Parameters

- `reader` (`Utf8JsonReader`): The `System.Text.Json.Utf8JsonReader` to read from.
- `typeToConvert` (`Type`): The type to convert.
- `options` (`JsonSerializerOptions`): The options to use when reading the value.

### Returns

The value that was converted.

## Write(Utf8JsonWriter, HierarchicalKey, JsonSerializerOptions) {#write-system-text-json-utf8jsonwriter-orleans-durable-messaging-hierarchicalkey-e72058e0}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.messaging.hierarchicalkey.hierarchicalkeyjsonconverter/methods/write-system-text-json-utf8jsonwriter-orleans-durable-messaging-hierarchicalkey-e72058e0/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Messaging/HierarchicalKey.cs#L53-L55)

```csharp
public override void Write(Utf8JsonWriter writer, HierarchicalKey value, JsonSerializerOptions options)
```

Writes a specified value as JSON.

### Parameters

- `writer` (`Utf8JsonWriter`): The writer to write to.
- `value` (`HierarchicalKey`): The value to convert to JSON.
- `options` (`JsonSerializerOptions`): An object that specifies serialization options to use.

## WriteAsPropertyName(Utf8JsonWriter, HierarchicalKey, JsonSerializerOptions) {#writeaspropertyname-system-text-json-utf8jsonwriter-orleans-durable-messaging-hi-04151b5e}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.messaging.hierarchicalkey.hierarchicalkeyjsonconverter/methods/writeaspropertyname-system-text-json-utf8jsonwriter-orleans-durable-messaging-hi-04151b5e/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Messaging/HierarchicalKey.cs#L64-L66)

```csharp
public override void WriteAsPropertyName(Utf8JsonWriter writer, HierarchicalKey value, JsonSerializerOptions options)
```

Writes a dictionary key as a JSON property name.

### Parameters

- `writer` (`Utf8JsonWriter`): The `System.Text.Json.Utf8JsonWriter` to write to.
- `value` (`HierarchicalKey`): The value to convert. The value of `System.Text.Json.Serialization.JsonConverter-1.HandleNull` determines if the converter handles `null` values.
- `options` (`JsonSerializerOptions`): The options to use when writing the value.
