OperatorApi

new OperatorApi()

Version:

Operator service.

Methods

getOperator(xChainId, operatorId, callback)

GetOperator Search for the settings of a specific operator.

Parameters:

Name	Type	Description
`xChainId`	String	Klaytn chain network ID (1001 or 8217)
`operatorId`	String	Operator account address
`callback`	OperatorApi~getOperatorCallback	The callback function, accepting three arguments: error, data, response data is of type: Operator

retrieveOperators(xChainId, opts, callback)

RetrieveOperators Search for a list of created operators and the settings of each of them.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:

Name Type Description

xChainId

String

Klaytn chain network ID (1001 or 8217)

opts

Object

Optional parameters

Properties

Name	Type	Description
`size`	Number	Maximum size of account to search (default to 100)
`cursor`	String	Information on last searched cursor
`fromTimestamp`	Number	Timestamp of the start time to be searched (in seconds)
`toTimestamp`	Number	Timestamp of the end time to be searched (in seconds)

callback

OperatorApi~retrieveOperatorsCallback

The callback function, accepting three arguments: error, data, response data is of type: Operators

Type Definitions

getOperatorCallback(error, data, response)

Callback function to receive the result of the getOperator operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Operator	The data returned by the service call.
`response`	String	The complete HTTP response.

retrieveOperatorsCallback(error, data, response)

Callback function to receive the result of the retrieveOperators operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Operators	The data returned by the service call.
`response`	String	The complete HTTP response.

OperatorApi

new OperatorApi(apiClientopt)

Constructs a new OperatorApi.

Parameters:

Name	Type	Attributes	Description
`apiClient`	ApiClient	<optional>	Optional API client implementation to use, default to ApiClient#instance if unspecified.

Methods

getOperator(xChainId, operatorId, callback)

GetOperator Search for the settings of a specific operator.

Parameters:

Name	Type	Description
`xChainId`	String	Klaytn chain network ID (1001 or 8217)
`operatorId`	String	Operator account address
`callback`	OperatorApi~getOperatorCallback	The callback function, accepting three arguments: error, data, response data is of type: Operator

retrieveOperators(xChainId, opts, callback)

RetrieveOperators Search for a list of created operators and the settings of each of them.

## Size

Parameters:

Name Type Description

xChainId

String

Klaytn chain network ID (1001 or 8217)

opts

Object

Optional parameters

Properties

Name	Type	Description
`size`	Number	Maximum size of account to search (default to 100)
`cursor`	String	Information on last searched cursor
`fromTimestamp`	Number	Timestamp of the start time to be searched (in seconds)
`toTimestamp`	Number	Timestamp of the end time to be searched (in seconds)

callback

OperatorApi~retrieveOperatorsCallback

The callback function, accepting three arguments: error, data, response data is of type: Operators

Type Definitions

getOperatorCallback(error, data, response)

Callback function to receive the result of the getOperator operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Operator	The data returned by the service call.
`response`	String	The complete HTTP response.

retrieveOperatorsCallback(error, data, response)

Callback function to receive the result of the retrieveOperators operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Operators	The data returned by the service call.
`response`	String	The complete HTTP response.