Constructor
new PathCallBuilder(serverUrl, source, destination, destinationAsset, destinationAmount)
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
serverUrl |
string
|
Horizon server URL. |
source |
string
|
The sender's account ID. Any returned path must use a source that the sender can hold. |
destination |
string
|
The destination account ID that any returned path should use. |
destinationAsset |
Asset
|
The destination asset. |
destinationAmount |
string
|
The amount, denominated in the destination asset, that any returned path should be able to satisfy. |
Extends
Methods
call() → {Promise}
Triggers a HTTP request using this builder's current configuration.
- Overrides:
- 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.
- Overrides:
- 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
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)`.
- Overrides:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
endpoint |
string
|
neighbor endpoint in question, like /operations |
param |
string
|
filter parameter, like an operation ID |
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.
- Overrides:
- 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.
- Overrides:
- Source:
- See:
Parameters:
Name | Type | Description |
---|---|---|
recordsNumber |
number
|
Number of records the server should return. |
Returns:
- Type:
-
object
current CallBuilder instance
order(direction) → {object}
Sets order
parameter for the current call. Returns the CallBuilder object on which this method has been called.
- Overrides:
- 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.
- Overrides:
- 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.