EffectCallBuilder

EffectCallBuilder

new EffectCallBuilder()

Source:

Extends

Methods

call() → {Promise}

Triggers a HTTP request using this builder's current configuration. Returns a Promise that resolves to the server's response.

Inherited From:
Source:
Returns:
Type:
Promise

cursor(cursor)

Adds cursor parameter to 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.

forAccount(accountId) → {EffectCallBuilder}

This endpoint represents all effects that changed a given account. It will return relevant effects from the creation of the account to the current ledger.

Source:
See:
Parameters:
Name Type Description
accountId string

For example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Returns:
Type:
EffectCallBuilder

forLedger(sequence) → {EffectCallBuilder}

Effects are the specific ways that the ledger was changed by any operation.

This endpoint represents all effects that occurred in the given ledger.

Source:
See:
Parameters:
Name Type Description
sequence number | string

Ledger sequence
Returns:
Type:
EffectCallBuilder

forOperation(operationId) → {EffectCallBuilder}

This endpoint represents all effects that occurred as a result of a given operation.

Source:
See:
Parameters:
Name Type Description
operationId number

Operation ID
Returns:
Type:
EffectCallBuilder

forTransaction(transactionId) → {EffectCallBuilder}

This endpoint represents all effects that occurred as a result of a given transaction.

Source:
See:
Parameters:
Name Type Description
transactionId string

Transaction ID
Returns:
Type:
EffectCallBuilder

limit(number)

Adds limit parameter to the current call. Returns the CallBuilder object on which this method has been called.

Inherited From:
Source:
See:
Parameters:
Name Type Description
number number

Number of records the server should return.

order(direction)

Adds order parameter to the current call. Returns the CallBuilder object on which this method has been called.

Inherited From:
Source:
Parameters:
Name Type Description
direction "asc" | "desc"

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.

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.