AVMWebClient

• Static Methods
  • init([options])
    • Parameters
    • Returns
• Methods
  • disable([params])
    • Parameters
    • Returns
  • discover([params])
    • Parameters
    • Returns
  • enable([params])
    • Parameters
    • Returns
  • getConfig()
    • Returns
  • onDisable(callback)
    • Parameters
    • Returns
  • onDiscover(callback)
    • Parameters
    • Returns
  • onEnable(callback)
    • Parameters
    • Returns
  • onPostTransactions(callback)
    • Parameters
    • Returns
  • onSignAndPostTransactions(callback)
    • Parameters
    • Returns
  • onSignMessage(callback)
    • Parameters
  • onSignTransactions(callback)
    • Parameters
    • Returns
  • postTransactions([params])
    • Parameters
    • Returns
  • removeAllListeners()
    • Returns
  • removeListener(id)
    • Parameters
    • Returns
  • signAndpostTransactions([params])
    • Parameters
    • Returns
  • signMessage([params])
    • Parameters
    • Returns
  • signTransactions([params])
    • Parameters
    • Returns

Static Methods

init([options])

Initializes the AVM web client object. If no options are supplied, a default configuration is used.

Parameters

Name	Type	Required	Default	Description
options	IAVMWebClientInitOptions	no	-	An object to change the initial configuration.

Returns

Type	Description
AVMWebClient	An initialized AVM web client object.

Methods

disable([params])

Sends a request to remove the client from providers.

Parameters

Name	Type	Required	Default	Description
params	IDisableParams	no	-	Params that specify which provider,network and/or specific session IDs.

Returns

Type	Description
string	the ID of the request message.

discover([params])

Sends a request to get information relating to available providers. This should be called before interacting with any providers to ensure networks and methods are supported.

Parameters

Name	Type	Required	Default	Description
params	IDiscoverParams	no	-	Params that specify which provider to target.

Returns

Type	Description
string	the ID of the request message.

enable([params])

Enables to a client with providers. If the ID of the provider and/or network is specified, that provider/network is used, otherwise the all providers available providers are used.

Parameters

Name	Type	Required	Default	Description
params	IEnableParams	no	-	Params that specify the provider and/or the network.

Returns

Type	Description
string	the ID of the request message.

getConfig()

Returns the configuration.

Returns

Type	Description
IAVMWebClientConfig	The client's configuration.

onDisable(callback)

Listens to disable messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

onDiscover(callback)

Listens to discover messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

onEnable(callback)

Listens to enable messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

onPostTransactions(callback)

Listens to post_transactions messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

onSignAndPostTransactions(callback)

Listens to sign_and_post_transactions messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

onSignMessage(callback)

Listens to sign_message messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

onSignTransactions(callback)

Listens to sign_transactions messages sent from providers.

Parameters

Name	Type	Required	Default	Description
callback	(options: IAVMWebClientCallbackOptions) => (void | Promise<void>)	yes	-	The callback is called when a response message is received. If the result was successful, the error parameter will be null.

Returns

Type	Description
string	the ID of the listener.

postTransactions([params])

Request providers to post a list of signed transactions to the network.

Parameters

Name	Type	Required	Default	Description
params	IPostTransactionsParams	yes	-	Params that specify the provider and the signed transactions.

Returns

Type	Description
string	the ID of the request message.

removeAllListeners()

Removes all listeners.

Returns

Type	Description
void	-

removeListener(id)

Removes the listener, by the ID.

Parameters

Name	Type	Required	Default	Description
id	string	yes	-	The listener ID to remove.

Returns

Type	Description
void	-

signAndpostTransactions([params])

Request providers to sign and post a list of unsigned transactions to the network.

Parameters

Name	Type	Required	Default	Description
params	ISignTransactionsParams	yes	-	Params that specify the unsigned transactions and the provider.

Returns

Type	Description
string	the ID of the request message.

signMessage([params])

Request providers sign a UTF-8 encoded message.

Parameters

Name	Type	Required	Default	Description
params	ISignMessageParams	yes	-	Params that specify the message to sign, the signer and the provider.

Returns

Type	Description
string	the ID of the request message.

signTransactions([params])

Request providers to sign a list of unsigned transactions.

Parameters

Name	Type	Required	Default	Description
params	ISignTransactionsParams	yes	-	Params that specify the unsigned transactions and the provider.

Returns

Type	Description
string	the ID of the request message.