Files
api/docs/api-observable/classes/_calls_.apicalls.md
T
2018-10-04 10:18:42 +00:00

20 KiB

Hierarchy

↳ ApiQueries

↳ ApiCalls

↳ ApiCombined

Constructors

constructor

⊕ new ApiCalls(api: RxApiInterface): ApiCalls

Inherited from ApiBase.constructor

Defined in Base.ts:31

Parameters:

Param Type
api RxApiInterface

Returns: ApiCalls


Properties

<Protected> _api

● _api: RxApiInterface

Inherited from ApiBase._api

Defined in Base.ts:27


<Protected> _genesisHash

● _genesisHash: Hash

Inherited from ApiBase._genesisHash

Defined in Base.ts:28


whenReady

● whenReady: Observable<boolean>

Inherited from ApiBase.whenReady

Defined in Base.ts:31


<Static> extrinsics

● extrinsics: Extrinsics = extrinsicsStatic

Inherited from ApiBase.extrinsics

Defined in Base.ts:39


<Static> storage

● storage: Storage = storageStatic

Inherited from ApiBase.storage

Defined in Base.ts:40


Accessors

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:78

Returns: Hash


Methods

bestNumber

▸ bestNumber(): Observable< BlockNumber | undefined>

Defined in Calls.ts:13

Returns: Observable< BlockNumber | undefined>


chainGetBlock

▸ chainGetBlock(hash: Uint8Array): Observable< SignedBlock | undefined>

Defined in Calls.ts:25

Parameters:

Param Type
hash Uint8Array

Returns: Observable< SignedBlock | undefined>


chainNewHead

▸ chainNewHead(): Observable< Header | undefined>

Defined in Calls.ts:29

Returns: Observable< Header | undefined>


<Protected> combine

▸ combine<T,R>(observables: Array<Observable<any>>, mapfn?: MapFn<R, T>): Observable<T>

Inherited from ApiBase.combine

Defined in Base.ts:70

Type parameters:

T

R

Parameters:

Param Type Default value
observables Array<Observable<any>> -
Default value mapfn MapFn<R, T> defaultMapFn

Returns: Observable<T>


democacyVoteOf

▸ democacyVoteOf(index: * ReferendumIndex | BN | number, address: * AccountId | string): Observable<Bool>

Inherited from ApiQueries.democacyVoteOf

Defined in Queries.ts:76

Parameters:

Param Type
index ReferendumIndex | BN | number
address AccountId | string

Returns: Observable<Bool>


democacyVotersFor

▸ democacyVotersFor(index: * ReferendumIndex | BN | number*): Observable<Array<AccountId>>

Inherited from ApiQueries.democacyVotersFor

Defined in Queries.ts:80

Parameters:

Param Type
index ReferendumIndex | BN | number

Returns: Observable<Array<AccountId>>


democracyLaunchPeriod

▸ democracyLaunchPeriod(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.democracyLaunchPeriod

Defined in Queries.ts:19

Returns: Observable< BlockNumber | undefined>


democracyNextTally

▸ democracyNextTally(): Observable< ReferendumIndex | undefined>

Inherited from ApiQueries.democracyNextTally

Defined in Queries.ts:23

Returns: Observable< ReferendumIndex | undefined>


democracyProposalDeposits

▸ democracyProposalDeposits(proposalId: * PropIndex | BN | number*): Observable< RxProposalDeposits | undefined>

Inherited from ApiQueries.democracyProposalDeposits

Defined in Queries.ts:27

Parameters:

Param Type
proposalId PropIndex | BN | number

Returns: Observable< RxProposalDeposits | undefined>


democracyPublicProposals

▸ democracyPublicProposals(): Observable<Array<RxProposal>>

Inherited from ApiQueries.democracyPublicProposals

Defined in Queries.ts:40

Returns: Observable<Array<RxProposal>>


democracyReferendumCount

▸ democracyReferendumCount(): Observable< ReferendumIndex | undefined>

Inherited from ApiQueries.democracyReferendumCount

Defined in Queries.ts:59

Returns: Observable< ReferendumIndex | undefined>


democracyReferendumInfoOf

▸ democracyReferendumInfoOf(referendumId: * ReferendumIndex | BN | number*): Observable< RxReferendum | undefined>

Inherited from ApiQueries.democracyReferendumInfoOf

Defined in Queries.ts:63

Parameters:

Param Type
referendumId ReferendumIndex | BN | number

Returns: Observable< RxReferendum | undefined>


democracyVotingPeriod

▸ democracyVotingPeriod(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.democracyVotingPeriod

Defined in Queries.ts:91

Returns: Observable< BlockNumber | undefined>


eraLastLengthChange

▸ eraLastLengthChange(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.eraLastLengthChange

Defined in Queries.ts:116

Returns: Observable< BlockNumber | undefined>


fees

▸ fees(): Observable<RxFees>

Inherited from ApiQueries.fees

Defined in Queries.ts:95

Returns: Observable<RxFees>


isConnected

▸ isConnected(): Observable<boolean>

Inherited from ApiBase.isConnected

Defined in Base.ts:82

Returns: Observable<boolean>


rawCall

▸ rawCall<T>(__namedParameters: object, ...params: Array<any>): Observable<T>

Inherited from ApiBase.rawCall

Defined in Base.ts:86

Type parameters:

T

Parameters:

Param Type
__namedParameters object
Rest params Array<any>

Returns: Observable<T>


rawStorage

▸ rawStorage<T>(key: StorageFunction, ...params: Array<any>): Observable<T>

Inherited from ApiBase.rawStorage

Defined in Base.ts:98

Type parameters:

T

Parameters:

Param Type
key StorageFunction
Rest params Array<any>

Returns: Observable<T>


rawStorageMulti

▸ rawStorageMulti<T>(...keys: Array< [StorageFunction] | [StorageFunction, any]>): Observable<T>

Inherited from ApiBase.rawStorageMulti

Defined in Base.ts:109

Type parameters:

T

Parameters:

Param Type
Rest keys Array< [StorageFunction] | [StorageFunction, any]>

Returns: Observable<T>


sessionCurrentIndex

▸ sessionCurrentIndex(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionCurrentIndex

Defined in Queries.ts:128

Returns: Observable< BlockNumber | undefined>


sessionCurrentStart

▸ sessionCurrentStart(): Observable< Moment | undefined>

Inherited from ApiQueries.sessionCurrentStart

Defined in Queries.ts:132

Returns: Observable< Moment | undefined>


sessionLastLengthChange

▸ sessionLastLengthChange(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionLastLengthChange

Defined in Queries.ts:136

Returns: Observable< BlockNumber | undefined>


sessionLength

▸ sessionLength(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionLength

Defined in Queries.ts:140

Returns: Observable< BlockNumber | undefined>


sessionReward

▸ sessionReward(): Observable< Perbill | undefined>

Inherited from ApiQueries.sessionReward

Defined in Queries.ts:120

Returns: Observable< Perbill | undefined>


sessionRewardCurrent

▸ sessionRewardCurrent(): Observable< Balance | undefined>

Inherited from ApiQueries.sessionRewardCurrent

Defined in Queries.ts:124

Returns: Observable< Balance | undefined>


sessionValidators

▸ sessionValidators(): Observable<Array<AccountId>>

Inherited from ApiQueries.sessionValidators

Defined in Queries.ts:148

Returns: Observable<Array<AccountId>>


sessionsPerEra

▸ sessionsPerEra(): Observable< BlockNumber | undefined>

Inherited from ApiQueries.sessionsPerEra

Defined in Queries.ts:144

Returns: Observable< BlockNumber | undefined>


stakingFreeBalanceOf

▸ stakingFreeBalanceOf(address: * AccountId | string*): Observable< Balance | undefined>

Inherited from ApiQueries.stakingFreeBalanceOf

Defined in Queries.ts:171

Parameters:

Param Type
address AccountId | string

Returns: Observable< Balance | undefined>


stakingIntentions

▸ stakingIntentions(): Observable<Array<AccountId>>

Inherited from ApiQueries.stakingIntentions

Defined in Queries.ts:159

Returns: Observable<Array<AccountId>>


stakingNominating

▸ stakingNominating(address: * AccountId | string*): Observable< AccountId | undefined>

Inherited from ApiQueries.stakingNominating

Defined in Queries.ts:186

Parameters:

Param Type
address AccountId | string

Returns: Observable< AccountId | undefined>


stakingNominatorsFor

▸ stakingNominatorsFor(address: * AccountId | string*): Observable<Array<AccountId>>

Inherited from ApiQueries.stakingNominatorsFor

Defined in Queries.ts:175

Parameters:

Param Type
address AccountId | string

Returns: Observable<Array<AccountId>>


stakingReservedBalanceOf

▸ stakingReservedBalanceOf(address: * AccountId | string*): Observable< Balance | undefined>

Inherited from ApiQueries.stakingReservedBalanceOf

Defined in Queries.ts:191

Parameters:

Param Type
address AccountId | string

Returns: Observable< Balance | undefined>


systemAccountIndexOf

▸ systemAccountIndexOf(address: * AccountId | string*): Observable< Index | undefined>

Inherited from ApiQueries.systemAccountIndexOf

Defined in Queries.ts:203

Parameters:

Param Type
address AccountId | string

Returns: Observable< Index | undefined>


timestampBlockPeriod

▸ timestampBlockPeriod(): Observable< Moment | undefined>

Inherited from ApiQueries.timestampBlockPeriod

Defined in Queries.ts:195

Returns: Observable< Moment | undefined>


timestampNow

▸ timestampNow(): Observable< Moment | undefined>

Inherited from ApiQueries.timestampNow

Defined in Queries.ts:199

Returns: Observable< Moment | undefined>


validatorCount

▸ validatorCount(): Observable<u32>

Inherited from ApiQueries.validatorCount

Defined in Queries.ts:207

Returns: Observable<u32>