ClaimableBalanceCallBuilder

ClaimableBalanceCallBuilder

ClaimableBalanceCallBuilder

Constructor

new ClaimableBalanceCallBuilder(serverUrl)

Source:
See:
Parameters:
Name Type Description
serverUrl string

Horizon server URL.

Extends

Methods

asset(The) → {ClaimableBalanceCallBuilder}

Returns all claimable balances which provide a balance for the given asset.

Source:
See:
Parameters:
Name Type Description
The Asset

Asset held by the claimable balance
Returns:
Type:
ClaimableBalanceCallBuilder

current ClaimableBalanceCallBuilder instance

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.

claimableBalance(claimableBalanceId) → {CallBuilder.<ServerApi.ClaimableBalanceRecord>}

The claimable balance details endpoint provides information on a single claimable balance.

Source:
See:
Parameters:
Name Type Description
claimableBalanceId string

Claimable balance ID
Returns:
Type:
CallBuilder.<ServerApi.ClaimableBalanceRecord>

CallBuilder<ServerApi.ClaimableBalanceRecord> OperationCallBuilder instance

claimant(claimant) → {ClaimableBalanceCallBuilder}

Returns all claimable balances which can be claimed by the given account ID.

Source:
See:
Parameters:
Name Type Description
claimant string

For example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Returns:
Type:
ClaimableBalanceCallBuilder

current ClaimableBalanceCallBuilder instance

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
Returns:
Type:
CallBuilder

this CallBuilder instance

join(join) → {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
join "transactions"

Records to be included in the response.
Returns:
Type:
object

current CallBuilder instance.

limit(number) → {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
number 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

Returns all claimable balances which are sponsored by the given account ID.

Source:
See:
Parameters:
Name Type Description
sponsor string

For example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Returns:
Type:
ClaimableBalanceCallBuilder

current ClaimableBalanceCallBuilder 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.

Name Type Attributes Description
onmessage function <optional>

Callback function to handle incoming messages.
onerror function <optional>

Callback function to handle errors.
reconnectTimeout number <optional>

Custom stream connection timeout in ms, default is 15 seconds.
Returns:
Type:
function

Close function. Run to close the connection and stop listening for new events.