Class TokenNameFilter

Predicate filter on the name query parameter of the /api/v1/tokens list endpoint. Matches tokens whose name contains the given substring (partial match).

Inheritance

object

TokenNameFilter

Implements

IMirrorFilter

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 TokenNameFilter : IMirrorFilter, IMirrorQueryParameter

Remarks

The mirror-node server imposes two hard rules on this filter, neither enforced client-side by this type:

- It cannot be combined with TokenFilter or AccountFilter in the same request. The server will reject the request if they appear together.

- When this filter is present the mirror node disables pagination; results are ordered by token.id according to the supplied OrderBy and PageLimit behavior becomes effectively best-effort.

OpenAPI restricts the substring to a minimum of 3 and a maximum of 100 characters; the factory enforces this bound locally so out-of-range values throw before the request is sent.

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

Methods

Contains(string)

Matches tokens whose name contains the given substring.

Declaration

public static TokenNameFilter Contains(string nameFragment)

Parameters

Type	Name	Description
string	nameFragment	3–100 characters of the token name to match. Values outside that bound throw ArgumentOutOfRangeException.

Returns

Type	Description
TokenNameFilter

Implements

IMirrorFilter

IMirrorQueryParameter