Class MessageEncodingProjectionFilter

Projection toggle on the encoding query parameter — controls how the mirror node encodes each HCS topic message's payload in the returned JSON. Implements IMirrorProjection: it does not narrow which records are returned, only reshapes each response payload.

Inheritance

object

MessageEncodingProjectionFilter

Implements

IMirrorProjection

IMirrorQueryParameter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero.Mirror.Filters

Assembly: Hiero.dll

Syntax

public sealed class MessageEncodingProjectionFilter : IMirrorProjection, IMirrorQueryParameter

Remarks

The mirror-node default is encoding=base64; selecting Utf8 asks the server to decode the message bytes as UTF-8 text before returning them. The latter is valid only when the payload actually is UTF-8 — for binary payloads the server may return null or reject the request.

Accepted by /api/v1/topics/{topicId}/messages.

Fields

Base64

Return each message payload as a base64-encoded string (the server's default behavior — explicit here for call-site clarity).

Declaration

public static readonly MessageEncodingProjectionFilter Base64

Field Value

Type	Description
MessageEncodingProjectionFilter

Utf8

Return each message payload as plain UTF-8 text. Valid only when the payload bytes actually are UTF-8; non-text payloads may yield a null field or a server error.

Declaration

public static readonly MessageEncodingProjectionFilter Utf8

Field Value

Type	Description
MessageEncodingProjectionFilter

Properties

Name

The query parameter name recognized by the remote mirror node.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Value

The value of the query parameter sent to the mirror node.

Declaration

public string Value { get; }

Property Value

Type	Description
string

Implements

IMirrorProjection

IMirrorQueryParameter