npm
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AliasApi

Alias API

Work in Progress

Hierarchy

  • AliasApi

Index

Properties

Properties

buyAlias

buyAlias: function

Buys an Alias

param

The args

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

Type declaration

buyTopLevelDomain

buyTopLevelDomain: function

Buys a Top Level Domain (TLD)

param

The args

Type declaration

getAliasById

getAliasById: function

Get alias by its id, i.e. get basic account info for given alias name

param

The alias id

returns

The Alias object

Type declaration

    • (aliasId: string): Promise<Alias>

    • Parameters

      • aliasId: string

      Returns Promise<Alias>

getAliasByName

getAliasByName: function

Get alias by name, i.e. get basic account info for given alias name

param

The alias name

param

optional Top Level Domain. If not given, the default domain 'signum' is being used

returns

The Alias object

Type declaration

    • (aliasName: string, tld?: string): Promise<Alias>

    • Parameters

      • aliasName: string
      • Optional tld: string

      Returns Promise<Alias>

getAliases

getAliases: function

Gets the aliases

param
returns

A list of aliases according the matches

Type declaration

getAliasesOnSale

getAliasesOnSale: function

Get all aliases, which are on sale.

param

The arguments

returns

The Alias List (at maximum 500 per page)

Type declaration

getTopLevelDomains

getTopLevelDomains: function

Gets all registered Top Level Domains

param

The args

Type declaration

searchAliasesByName

searchAliasesByName: function

Searches for aliases by their name or part of the name

param

The args

Type declaration

sellAlias

sellAlias: function

Sells an Alias. Sales can be public if no recipient is defined, i.e. everybody can buy it, or only per account in case the recipient is given.

param

The args

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

Type declaration

setAlias

setAlias: function

Sets or Updates an Alias

param

The arguments

returns

The Transaction Id or Unsigned Bytes as Hex String if no private key was sent

Type declaration