Olympe SDK

Class: Parameters

Parameters

Query parameters

new Parameters()

Methods

<static> valueToString(value)

Returns a string representation of the specified value or the node id if the value is a number

Parameters:
Name Type Description
value *
Returns:
Type
string

add(value)

Adds a parameter and returns its unique identifier

Parameters:
Name Type Description
value *

Parameter value
Returns:

Parameter unique identifier

Type
string

clear()

Removes all parameters

forEach(callback)

Calls the specified callback for each parameters

Parameters:
Name Type Description
callback olympe.dc.query.Parameters.ForEachCallback

get(id)

Gets a parameter value by its unique identifier

Parameters:
Name Type Description
id string

Parameter unique identifier
Returns:

Parameter value

Type
*

serializeValue(value)

Serializes the specified value and, if it is a data flow, adds it

Parameters:
Name Type Description
value *
Returns:
Type
string

Type Definitions

ForEachCallback(value, key)

Parameters:
Name Type Description
value *
key string