Connectors Reference

Xooa Blockchain Smart Contract

Xooa makes it easy to use blockchain by eliminating common barriers. A blockchain platform as a service (PaaS) provides an enterprise blockchain. The connector provides an immutable ledger and a private blockchain infrastructure. You control who can view and participate in the ledger, and you can shift your data to your own network at any time.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

Query (string fcn, [advanced][Optional]boolean async, [advanced][Optional]integer timeout, array body)

Perform a query function

Invoke (string fcn, [advanced][Optional]boolean async, [advanced][Optional]integer timeout, array body)

Invoke a function

Get ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

Xooa GET

Set ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

Xooa SET

Del ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

Xooa DEL

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

 

Actions:

Query

Summary: Perform a query function

Description: Query the ledger using a given smart contract function. The query end-point is used to perform read operations. Such operations do not create transactions in the ledger.

 

Syntax:

XooaBlockchainSmartContract.Query (string fcn, [advanced][Optional]boolean async, [advanced][Optional]integer timeout, array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

fcn

string

(Function name)

The name of the function.

True

async

boolean

(Asynchronous call indicator (Boolean))

Specifies whether to perform the call asynchronously (default is false).

False

timeout

integer

(Timeout (synchronous calls only))

Timeout waiting on a response from a synchronous call (async false). A 202 Pending Transaction Response with the URL to retrieve appears if the timeout value is exceeded. Default timeout value is 5000ms.

False

body

array of (string)

 

 

True

 

Returns:

          Type:string

 

Invoke

Summary: Invoke a function

Description: Invoke a given custom smart contract function to write to the ledger.Such operations create transactions in the ledger.

 

Syntax:

XooaBlockchainSmartContract.Invoke (string fcn, [advanced][Optional]boolean async, [advanced][Optional]integer timeout, array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

fcn

string

(Function name)

The name of the function.

True

async

boolean

(Asynchronous call indicator (Boolean))

Specifies whether to perform the call asynchronously (default is false).

False

timeout

integer

(Timeout (synchronous calls only))

Timeout waiting on a response from a synchronous call (async false). A 202 Pending Transaction Response with the URL to retrieve appears if the timeout value is exceeded. Default timeout value is 5000ms.

False

body

array of (string)

 

 

True

 

Returns:

          Type:string

 

Get

Summary: Xooa GET

Description: This action is used to perform a 'get' operation on the Xooa App. This operation invokes the get function in the Smart Contract to give the latest state from the Blockchain.

 

Syntax:

XooaBlockchainSmartContract.Get ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

async

boolean

(Async call indicator)

This parameter is used to define if the call to Xooa is to be made in synchronous or asynchronous mode. Its default value is false, i.e. synchronous mode.

False

timeout

integer

(Amount of time to wait before turning a synchronous call to asynchronous.)

If a call to Xooa is made in synchronous mode then the call waits for the time passed in timeout to receive a response. If a response is not generated within the given timeout a pending response is generated. Default timeout value is 3000ms.

False

body

array of (string)

 

 

False

 

Returns:

          Type:string

 

Set

Summary: Xooa SET

Description: This action is used to perform a 'set' operation on the Xooa App. This operation invokes the set function in the Smart Contract to store the key value pairs in the Blockchain. This operation generates a transaction in the blockchain and stores it in the ledger.

 

Syntax:

XooaBlockchainSmartContract.Set ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

async

boolean

(Async call indicator)

This parameter is used to define if the call to Xooa is to be made in synchronous or asynchronous mode. Its default value is false, i.e. synchronous mode.

False

timeout

integer

(Amount of time to wait before turning a synchronous call to asynchronous.)

If a call to Xooa is made in synchronous mode then the call waits for the time passed in timeout to receive a response. If a response is not generated within the given timeout a pending response is generated. Default timeout value is 3000ms.

False

body

array of (string)

 

 

False

 

Returns:

          Type:string

 

Del

Summary: Xooa DEL

Description: This action is used to perform a 'del' operation on the Xooa App. This operation invokes the del function in the Smart Contract to delete the key from the Blockchain. This operation generates a transaction in the blockchain and stores it in the ledger.

 

Syntax:

XooaBlockchainSmartContract.Del ([advanced][Optional]boolean async, [advanced][Optional]integer timeout, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

async

boolean

(Async call indicator)

This parameter is used to define if the call to Xooa is to be made in synchronous or asynchronous mode. Its default value is false, i.e. synchronous mode.

False

timeout

integer

(Amount of time to wait before turning a synchronous call to asynchronous.)

If a call to Xooa is made in synchronous mode then the call waits for the time passed in timeout to receive a response. If a response is not generated within the given timeout a pending response is generated. Default timeout value is 3000ms.

False

body

array of (string)

 

 

False

 

Returns:

          Type:string