Interface GetNamesOptionalParams

Optional parameters.

interface GetNamesOptionalParams {
    by?: string;
    direction?: string;
    limit?: number;
    ownedBy?: `ak_${string}`;
    prefix?: string;
    state?: string;
}

Hierarchy

  • OperationOptions
    • GetNamesOptionalParams

Properties

by? direction? limit? ownedBy? prefix? state?

Properties

Optionalby

by?: string

Sorting by deactivation, activation or name

Optionaldirection

direction?: string

Sorts results in forwards or backwards direction

Optionallimit

limit?: number

Limit paginated resources (max 100)

OptionalownedBy

ownedBy?: `ak_${string}`

Account that owns the name Account address

Optionalprefix

prefix?: string

Name prefix filter (case insensitive). Requires by=name parameter

Optionalstate

state?: string

Activation state of the name (active or inactive)

Settings

Member Visibility

On This Page

Properties