NamespaceHttp | symbol-sdk

Namespace http repository.

since: 1.0

Hierarchy

Http
- NamespaceHttp

Implements

NamespaceRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NamespaceHttp(url: string, networkType?: NetworkType | Observable<NetworkType>): NamespaceHttp

Overrides Http.constructor
- Defined in infrastructure/NamespaceHttp.ts:55
Constructor

Parameters
- url: string
- Optional networkType: NetworkType | Observable<NetworkType>
Returns NamespaceHttp

Properties

Protected url

url: string

Methods

Protected call

call<D, M>(remoteCall: Promise<{ body: D; response: IncomingMessage }>, mapper: (value: D, index: number) => M): Observable<M>

Inherited from Http.call
- Defined in infrastructure/Http.ts:94
This method knows how to call, convert and handle exception when doing remote http operations.

Type parameters
- D
- M
Parameters
- remoteCall: Promise<{ body: D; response: IncomingMessage }>
  
  the remote call
- mapper: (value: D, index: number) => M
  
  the mapper from dto to the model object.
  - - (value: D, index: number): M
    - Parameters
      - value: D
      - index: number
      Returns M
Returns Observable<M>

createNetworkTypeObservable

createNetworkTypeObservable(networkType?: NetworkType | Observable<NetworkType>): Observable<NetworkType>

Inherited from Http.createNetworkTypeObservable
- Defined in infrastructure/Http.ts:39
Parameters
- Optional networkType: NetworkType | Observable<NetworkType>
Returns Observable<NetworkType>

errorHandling

errorHandling(error: any): Error

Inherited from Http.errorHandling
- Defined in infrastructure/Http.ts:68
Parameters
- error: any
Returns Error

Private extractLevels

extractLevels(namespace: NamespaceDTO): NamespaceId[]

- Defined in infrastructure/NamespaceHttp.ts:266
Parameters
- namespace: NamespaceDTO
Returns NamespaceId[]

getAccountsNames

getAccountsNames(addresses: Address[]): Observable<AccountNames[]>

Implementation of NamespaceRepository.getAccountsNames
- Defined in infrastructure/NamespaceHttp.ts:74
Returns friendly names for array of addresses.

summary

Get readable names for a set of array of addresses

Parameters
- addresses: Address[]
  
  Array of addresses
Returns Observable<AccountNames[]>

getLinkedAddress

getLinkedAddress(namespaceId: NamespaceId): Observable<Address>

Implementation of NamespaceRepository.getLinkedAddress
- Defined in infrastructure/NamespaceHttp.ts:220
Gets the Address from a AddressAlias

Parameters
- namespaceId: NamespaceId
  
  the namespaceId of the namespace
Returns Observable<Address>

Observable

getLinkedMosaicId

getLinkedMosaicId(namespaceId: NamespaceId): Observable<MosaicId>

Implementation of NamespaceRepository.getLinkedMosaicId
- Defined in infrastructure/NamespaceHttp.ts:193
Gets the MosaicId from a MosaicAlias

Parameters
- namespaceId: NamespaceId
  
  the namespaceId of the namespace
Returns Observable<MosaicId>

Observable<MosaicId | null>

getMosaicsNames

getMosaicsNames(mosaicIds: MosaicId[]): Observable<MosaicNames[]>

Implementation of NamespaceRepository.getMosaicsNames
- Defined in infrastructure/NamespaceHttp.ts:97
Get readable names for a set of mosaics Returns friendly names for mosaics.

Parameters
- mosaicIds: MosaicId[]
  
  Array of mosaic ids
Returns Observable<MosaicNames[]>

Observable<MosaicNames[]>

getNamespace

getNamespace(namespaceId: NamespaceId): Observable<NamespaceInfo>

Implementation of NamespaceRepository.getNamespace
- Defined in infrastructure/NamespaceHttp.ts:119
Gets the NamespaceInfo for a given namespaceId

Parameters
- namespaceId: NamespaceId
  
  Namespace id
Returns Observable<NamespaceInfo>

Observable

getNamespacesFromAccount

getNamespacesFromAccount(address: Address, queryParams?: QueryParams): Observable<NamespaceInfo[]>

Implementation of NamespaceRepository.getNamespacesFromAccount
- Defined in infrastructure/NamespaceHttp.ts:133
Gets array of NamespaceInfo for an account

Parameters
- address: Address
  
  Address
- Optional queryParams: QueryParams
  
  (Optional) Query params
Returns Observable<NamespaceInfo[]>

Observable<NamespaceInfo[]>

getNamespacesFromAccounts

getNamespacesFromAccounts(addresses: Address[], queryParams?: QueryParams): Observable<NamespaceInfo[]>

Implementation of NamespaceRepository.getNamespacesFromAccounts
- Defined in infrastructure/NamespaceHttp.ts:155
Gets array of NamespaceInfo for different account

Parameters
- addresses: Address[]
  
  Array of Address
- Optional queryParams: QueryParams
  
  (Optional) Query params
Returns Observable<NamespaceInfo[]>

Observable<NamespaceInfo[]>

getNamespacesName

getNamespacesName(namespaceIds: NamespaceId[]): Observable<NamespaceName[]>

Implementation of NamespaceRepository.getNamespacesName
- Defined in infrastructure/NamespaceHttp.ts:173
Gets array of NamespaceName for different namespaceIds

Parameters
- namespaceIds: NamespaceId[]
  
  Array of namespace ids
Returns Observable<NamespaceName[]>

Observable<NamespaceName[]>

queryParams

queryParams(queryParams?: QueryParams): any

Inherited from Http.queryParams
- Defined in infrastructure/Http.ts:54
Parameters
- Optional queryParams: QueryParams
Returns any

Private toNamespaceInfo

toNamespaceInfo(dto: NamespaceInfoDTO, networkType: NetworkType): NamespaceInfo

- Defined in infrastructure/NamespaceHttp.ts:250
It maps from a NamespaceInfoDTO to NamespaceInfo

Parameters
- dto: NamespaceInfoDTO
  
  the dto
- networkType: NetworkType
  
  the network type
Returns NamespaceInfo

transactionFilter

transactionFilter(filter?: TransactionFilter): any

Inherited from Http.transactionFilter
- Defined in infrastructure/Http.ts:62
Parameters
- Optional filter: TransactionFilter
Returns any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional networkType: NetworkType | Observable<NetworkType>

Returns NamespaceHttp

Properties

Protected url

Methods

Protected call

Type parameters

D

M

Parameters

remoteCall: Promise<{ body: D; response: IncomingMessage }>

mapper: (value: D, index: number) => M

Parameters

value: D

index: number

Returns M

Returns Observable<M>

createNetworkTypeObservable

Parameters

Optional networkType: NetworkType | Observable<NetworkType>

Returns Observable<NetworkType>

errorHandling

Parameters

error: any

Returns Error

Private extractLevels

Parameters

namespace: NamespaceDTO

Returns NamespaceId[]

getAccountsNames

Parameters

addresses: Address[]

Returns Observable<AccountNames[]>

getLinkedAddress

Parameters

namespaceId: NamespaceId

Returns Observable<Address>

getLinkedMosaicId

Parameters

namespaceId: NamespaceId

Returns Observable<MosaicId>

getMosaicsNames

Parameters

mosaicIds: MosaicId[]

Returns Observable<MosaicNames[]>

getNamespace

Parameters

namespaceId: NamespaceId

Returns Observable<NamespaceInfo>

getNamespacesFromAccount

Parameters

address: Address

Optional queryParams: QueryParams

Returns Observable<NamespaceInfo[]>

getNamespacesFromAccounts

Parameters

addresses: Address[]

Optional queryParams: QueryParams

Returns Observable<NamespaceInfo[]>

getNamespacesName

Parameters

namespaceIds: NamespaceId[]

Returns Observable<NamespaceName[]>

queryParams

Parameters

Optional queryParams: QueryParams

Returns any

Private toNamespaceInfo

Parameters

dto: NamespaceInfoDTO