900 lines
26 KiB
Markdown
900 lines
26 KiB
Markdown
|
|
|
|
# Hierarchy
|
|
|
|
↳ [ApiCalls](_calls_.apicalls.md)
|
|
|
|
**↳ ApiCombined**
|
|
|
|
↳ [Api](_index_.api.md)
|
|
|
|
# Constructors
|
|
|
|
<a id="constructor"></a>
|
|
|
|
## constructor
|
|
|
|
⊕ **new ApiCombined**(api: *`RxApiInterface`*): [ApiCombined](_combined_.apicombined.md)
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
|
|
|
|
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L22)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| api | `RxApiInterface` |
|
|
|
|
**Returns:** [ApiCombined](_combined_.apicombined.md)
|
|
|
|
___
|
|
|
|
# Properties
|
|
|
|
<a id="api"></a>
|
|
|
|
## `<Protected>` api
|
|
|
|
**● api**: *`RxApiInterface`*
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
|
|
|
|
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L22)*
|
|
|
|
___
|
|
|
|
# Methods
|
|
|
|
<a id="bestnumber"></a>
|
|
|
|
## bestNumber
|
|
|
|
▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
|
|
|
|
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Calls.ts#L13)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="chaingetblock"></a>
|
|
|
|
## chainGetBlock
|
|
|
|
▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)*
|
|
|
|
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Calls.ts#L25)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| hash | `Uint8Array` |
|
|
|
|
**Returns:** `Observable`< `SignedBlock` | `undefined`>
|
|
|
|
___
|
|
<a id="chainnewhead"></a>
|
|
|
|
## chainNewHead
|
|
|
|
▸ **chainNewHead**(): `Observable`< `Header` | `undefined`>
|
|
|
|
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)*
|
|
|
|
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Calls.ts#L29)*
|
|
|
|
**Returns:** `Observable`< `Header` | `undefined`>
|
|
|
|
___
|
|
<a id="combine"></a>
|
|
|
|
## `<Protected>` combine
|
|
|
|
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
|
|
|
|
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L28)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
#### R
|
|
**Parameters:**
|
|
|
|
| Param | Type | Default value |
|
|
| ------ | ------ | ------ |
|
|
| observables | `Array`<`Observable`<`any`>> | - |
|
|
| `Default value` mapfn | `MapFn`<`R`, `T`> | defaultMapFn |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="democacyvoteof"></a>
|
|
|
|
## democacyVoteOf
|
|
|
|
▸ **democacyVoteOf**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`<`Bool`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
|
|
|
|
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L76)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<`Bool`>
|
|
|
|
___
|
|
<a id="democacyvotersfor"></a>
|
|
|
|
## democacyVotersFor
|
|
|
|
▸ **democacyVotersFor**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
|
|
|
|
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L80)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="democracylaunchperiod"></a>
|
|
|
|
## democracyLaunchPeriod
|
|
|
|
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
|
|
|
|
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L19)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="democracynexttally"></a>
|
|
|
|
## democracyNextTally
|
|
|
|
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
|
|
|
|
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L23)*
|
|
|
|
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
___
|
|
<a id="democracyproposalcount"></a>
|
|
|
|
## democracyProposalCount
|
|
|
|
▸ **democracyProposalCount**(): `Observable`<`number`>
|
|
|
|
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L20)*
|
|
|
|
**Returns:** `Observable`<`number`>
|
|
|
|
___
|
|
<a id="democracyproposaldeposits"></a>
|
|
|
|
## democracyProposalDeposits
|
|
|
|
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
|
|
|
|
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L27)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| proposalId | `PropIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`>
|
|
|
|
___
|
|
<a id="democracypublicproposals"></a>
|
|
|
|
## democracyPublicProposals
|
|
|
|
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
|
|
|
|
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L40)*
|
|
|
|
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
|
|
|
|
___
|
|
<a id="democracyreferendumcount"></a>
|
|
|
|
## democracyReferendumCount
|
|
|
|
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
|
|
|
|
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L59)*
|
|
|
|
**Returns:** `Observable`< `ReferendumIndex` | `undefined`>
|
|
|
|
___
|
|
<a id="democracyreferenduminfoof"></a>
|
|
|
|
## democracyReferendumInfoOf
|
|
|
|
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
|
|
|
|
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L63)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`< [RxReferendum](_classes_.rxreferendum.md) | `undefined`>
|
|
|
|
___
|
|
<a id="democracyreferenduminfos"></a>
|
|
|
|
## democracyReferendumInfos
|
|
|
|
▸ **democracyReferendumInfos**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L30)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumIds | `Array`< `ReferendumIndex` | `BN` | `number`> |
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
___
|
|
<a id="democracyreferendumvoters"></a>
|
|
|
|
## democracyReferendumVoters
|
|
|
|
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
|
|
|
|
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L42)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
|
|
|
|
___
|
|
<a id="democracyreferendums"></a>
|
|
|
|
## democracyReferendums
|
|
|
|
▸ **democracyReferendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L58)*
|
|
|
|
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
|
|
|
|
___
|
|
<a id="democracyvotersbalancesof"></a>
|
|
|
|
## democracyVotersBalancesOf
|
|
|
|
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>>
|
|
|
|
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L87)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`Balance`>>
|
|
|
|
___
|
|
<a id="democracyvotersvotesof"></a>
|
|
|
|
## democracyVotersVotesOf
|
|
|
|
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>>
|
|
|
|
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L103)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| referendumId | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** `Observable`<`Array`<`Bool`>>
|
|
|
|
___
|
|
<a id="democracyvotesof"></a>
|
|
|
|
## democracyVotesOf
|
|
|
|
▸ **democracyVotesOf**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`>
|
|
|
|
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L79)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| index | `ReferendumIndex` | `BN` | `number`|
|
|
| addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<`boolean`>
|
|
|
|
___
|
|
<a id="democracyvotingperiod"></a>
|
|
|
|
## democracyVotingPeriod
|
|
|
|
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
|
|
|
|
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L91)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablocklength"></a>
|
|
|
|
## eraBlockLength
|
|
|
|
▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L114)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablockprogress"></a>
|
|
|
|
## eraBlockProgress
|
|
|
|
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L129)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="erablockremaining"></a>
|
|
|
|
## eraBlockRemaining
|
|
|
|
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L151)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="eralastlengthchange"></a>
|
|
|
|
## eraLastLengthChange
|
|
|
|
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
|
|
|
|
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L116)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="fees"></a>
|
|
|
|
## fees
|
|
|
|
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
|
|
|
|
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L95)*
|
|
|
|
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
|
|
|
|
___
|
|
<a id="isconnected"></a>
|
|
|
|
## isConnected
|
|
|
|
▸ **isConnected**(): `Observable`<`boolean`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
|
|
|
|
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L36)*
|
|
|
|
**Returns:** `Observable`<`boolean`>
|
|
|
|
___
|
|
<a id="rawcall"></a>
|
|
|
|
## rawCall
|
|
|
|
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
|
|
|
|
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L40)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| __namedParameters | `object` |
|
|
| `Rest` params | `Array`<`any`> |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="rawstorage"></a>
|
|
|
|
## rawStorage
|
|
|
|
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
|
|
|
|
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L52)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| key | `StorageFunction` |
|
|
| `Rest` params | `Array`<`any`> |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="rawstoragemulti"></a>
|
|
|
|
## rawStorageMulti
|
|
|
|
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`>
|
|
|
|
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
|
|
|
|
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Base.ts#L63)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### T
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` keys | `Array`< [`StorageFunction`] | [`StorageFunction`, `any`]> |
|
|
|
|
**Returns:** `Observable`<`T`>
|
|
|
|
___
|
|
<a id="sessionblockprogress"></a>
|
|
|
|
## sessionBlockProgress
|
|
|
|
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L166)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionblockremaining"></a>
|
|
|
|
## sessionBlockRemaining
|
|
|
|
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L185)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionbrokenvalue"></a>
|
|
|
|
## sessionBrokenValue
|
|
|
|
▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L200)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessioncurrentindex"></a>
|
|
|
|
## sessionCurrentIndex
|
|
|
|
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
|
|
|
|
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L128)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessioncurrentstart"></a>
|
|
|
|
## sessionCurrentStart
|
|
|
|
▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
|
|
|
|
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L132)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionlastlengthchange"></a>
|
|
|
|
## sessionLastLengthChange
|
|
|
|
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
|
|
|
|
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L136)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionlength"></a>
|
|
|
|
## sessionLength
|
|
|
|
▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
|
|
|
|
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L140)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionreward"></a>
|
|
|
|
## sessionReward
|
|
|
|
▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
|
|
|
|
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L120)*
|
|
|
|
**Returns:** `Observable`< `Perbill` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionrewardcurrent"></a>
|
|
|
|
## sessionRewardCurrent
|
|
|
|
▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
|
|
|
|
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L124)*
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="sessiontimeexpected"></a>
|
|
|
|
## sessionTimeExpected
|
|
|
|
▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L219)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessiontimeremaining"></a>
|
|
|
|
## sessionTimeRemaining
|
|
|
|
▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L234)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="sessionvalidators"></a>
|
|
|
|
## sessionValidators
|
|
|
|
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
|
|
|
|
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L148)*
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="sessionsperera"></a>
|
|
|
|
## sessionsPerEra
|
|
|
|
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
|
|
|
|
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L144)*
|
|
|
|
**Returns:** `Observable`< `BlockNumber` | `undefined`>
|
|
|
|
___
|
|
<a id="stakingfreebalanceof"></a>
|
|
|
|
## stakingFreeBalanceOf
|
|
|
|
▸ **stakingFreeBalanceOf**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
|
|
|
|
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L171)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="stakingintentions"></a>
|
|
|
|
## stakingIntentions
|
|
|
|
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
|
|
|
|
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L159)*
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="stakingnominating"></a>
|
|
|
|
## stakingNominating
|
|
|
|
▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
|
|
|
|
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L186)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `AccountId` | `undefined`>
|
|
|
|
___
|
|
<a id="stakingnominatorsfor"></a>
|
|
|
|
## stakingNominatorsFor
|
|
|
|
▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
|
|
|
|
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L175)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<`Array`<`AccountId`>>
|
|
|
|
___
|
|
<a id="stakingreservedbalanceof"></a>
|
|
|
|
## stakingReservedBalanceOf
|
|
|
|
▸ **stakingReservedBalanceOf**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
|
|
|
|
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L191)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Balance` | `undefined`>
|
|
|
|
___
|
|
<a id="systemaccountindexof"></a>
|
|
|
|
## systemAccountIndexOf
|
|
|
|
▸ **systemAccountIndexOf**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
|
|
|
|
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L203)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`< `Index` | `undefined`>
|
|
|
|
___
|
|
<a id="timestampblockperiod"></a>
|
|
|
|
## timestampBlockPeriod
|
|
|
|
▸ **timestampBlockPeriod**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
|
|
|
|
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L195)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="timestampnow"></a>
|
|
|
|
## timestampNow
|
|
|
|
▸ **timestampNow**(): `Observable`< `Moment` | `undefined`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
|
|
|
|
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L199)*
|
|
|
|
**Returns:** `Observable`< `Moment` | `undefined`>
|
|
|
|
___
|
|
<a id="validatingbalance"></a>
|
|
|
|
## validatingBalance
|
|
|
|
▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L249)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
___
|
|
<a id="validatingbalances"></a>
|
|
|
|
## validatingBalances
|
|
|
|
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
|
|
|
|
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L274)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
|
|
|
|
___
|
|
<a id="validatorcount"></a>
|
|
|
|
## validatorCount
|
|
|
|
▸ **validatorCount**(): `Observable`<`u32`>
|
|
|
|
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
|
|
|
|
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Queries.ts#L207)*
|
|
|
|
**Returns:** `Observable`<`u32`>
|
|
|
|
___
|
|
<a id="votingbalance"></a>
|
|
|
|
## votingBalance
|
|
|
|
▸ **votingBalance**(_address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L288)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| _address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
|
|
|
|
___
|
|
<a id="votingbalances"></a>
|
|
|
|
## votingBalances
|
|
|
|
▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
|
|
|
|
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L322)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| `Rest` addresses | `Array`< `AccountId` | `string`> |
|
|
|
|
**Returns:** `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
|
|
|
|
___
|
|
<a id="votingbalancesnominatorsfor"></a>
|
|
|
|
## votingBalancesNominatorsFor
|
|
|
|
▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`>
|
|
|
|
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/0c906e5/packages/api-observable/src/Combined.ts#L311)*
|
|
|
|
**Parameters:**
|
|
|
|
| Param | Type |
|
|
| ------ | ------ |
|
|
| address | `AccountId` | `string`|
|
|
|
|
**Returns:** `Observable`<`any`>
|
|
|
|
___
|
|
|