new OperationCallBuilder(serverUrl)
Creates a new OperationCallBuilder pointed to server defined by serverUrl. Do not create this object directly, use Server#operations.
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
serverUrl |
string
|
Horizon server URL. |
Extends
Methods
call() → {Promise}
Triggers a HTTP request using this builder's current configuration.
- Inherited From:
- Source:
Returns:
- Type:
-
Promise
a Promise that resolves to the server's response.
cursor(cursor) → {object}
Sets cursor
parameter for the current call. Returns the CallBuilder object on which this method has been called.
- Inherited From:
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
cursor |
string
|
A cursor is a value that points to a specific location in a collection of resources. |
Returns:
- Type:
-
object
current CallBuilder instance
forAccount(accountId) → {OperationCallBuilder}
This endpoint represents all operations that were included in valid transactions that affected a particular account.
Parameters:
Name | Type | Description |
---|---|---|
accountId |
string
|
For example: |
forClaimableBalance(claimableBalanceId) → {OperationCallBuilder}
This endpoint represents all operations that reference a given claimable_balance.
Parameters:
Name | Type | Description |
---|---|---|
claimableBalanceId |
string
|
Claimable Balance ID |
forEndpoint(endpoint, param) → {CallBuilder}
A helper method to craft queries to "neighbor" endpoints.
For example, we have an /effects
suffix endpoint on many different
"root" endpoints, such as /transactions/:id
and /accounts/:id
. So,
it's helpful to be able to conveniently create queries to the
/accounts/:id/effects
endpoint:
this.forEndpoint("accounts", accountId)`.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
endpoint |
string
|
neighbor endpoint in question, like /operations |
param |
string
|
filter parameter, like an operation ID |
forLedger(sequence) → {OperationCallBuilder}
This endpoint returns all operations that occurred in a given ledger.
Parameters:
Name | Type | Description |
---|---|---|
sequence |
number
|
string
|
Ledger sequence |
forLiquidityPool(poolId) → {OperationCallBuilder}
This endpoint represents all operations involving a particular liquidity pool.
Parameters:
Name | Type | Description |
---|---|---|
poolId |
string
|
liquidity pool ID |
forTransaction(transactionId) → {OperationCallBuilder}
This endpoint represents all operations that are part of a given transaction.
Parameters:
Name | Type | Description |
---|---|---|
transactionId |
string
|
Transaction ID |
includeFailed(value) → {OperationCallBuilder}
Adds a parameter defining whether to include failed transactions. By default, only operations of successful transactions are returned.
Parameters:
Name | Type | Description |
---|---|---|
value |
boolean
|
Set to |
join("include") → {object}
Sets join
parameter for the current call. The join
parameter
includes the requested resource in the response. Currently, the
only valid value for the parameter is transactions
and is only
supported on the operations and payments endpoints. The response
will include a transaction
field for each operation in the
response.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
"include" |
join Records to be included in the response. |
Returns:
- Type:
-
object
current CallBuilder instance.
limit(recordsNumber) → {object}
Sets limit
parameter for the current call. Returns the CallBuilder object on which this method has been called.
- Inherited From:
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
recordsNumber |
number
|
Number of records the server should return. |
Returns:
- Type:
-
object
current CallBuilder instance
operation(operationId) → {CallBuilder}
The operation details endpoint provides information on a single operation. The operation ID provided in the id argument specifies which operation to load.
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
operationId |
number
|
Operation ID |
order(direction) → {object}
Sets order
parameter for the current call. Returns the CallBuilder object on which this method has been called.
- Inherited From:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
direction |
"asc"
|
"desc"
|
Sort direction |
Returns:
- Type:
-
object
current CallBuilder instance
stream(optionsopt) → {function}
Creates an EventSource that listens for incoming messages from the server. To stop listening for new events call the function returned by this method.
- Inherited From:
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object
|
<optional> |
EventSource options.
|
Returns:
- Type:
-
function
Close function. Run to close the connection and stop listening for new events.