Olympe SDK

Class: UpdateInstance

olympe.dc.transaction.operations. UpdateInstance

Update instance operation

new UpdateInstance(tag [, propTag] [, newValue])

Creates a UpdateInstance operation instance.

Parameters:
Name Type Argument Description
tag olympe.dc.InstanceTag

Instance tag
propTag olympe.dc.InstanceTag <optional>

Property tag
newValue olympe.df.OString | olympe.df.ONumber | olympe.df.OBoolean | olympe.df.Color | olympe.df.ODateTime | olympe.dc.Reference | string | number | boolean | olympe.df.Node | olympe.df.Proxy <optional>
<nullable>

Property new value

Extends

Methods

<protected> getCurrentTag(value)

Gets a tag from the specified InstanceTag or Sync constructor

Parameters:
Name Type Description
value olympe.dc.InstanceTag
Inherited From:
Overrides:
Returns:
Type
string

<protected> getCurrentValue(value)

Gets the current value of a Proxy. If this value is an ONumber, OString, ..., returns the corresponding primitive type. If this value is undefined, convert it to null.

Parameters:
Name Type Description
value olympe.df.Proxy | olympe.df.Node | *
Inherited From:
Overrides:
Returns:
Type
*

getCurrentValues(values)

Applies getCurrentValue() to all properties of the specified object and returns a new one containing the results

Parameters:
Name Type Description
values Map.<string, *>
Inherited From:
Overrides:
Returns:
Type
Map.<string, *>

getTag()

Gets the tag of the instance to update

Returns:
Type
string

setProperty(tag, value)

Sets a property value to update

Parameters:
Name Type Argument Description
tag olympe.dc.InstanceTag
value olympe.df.OString | olympe.df.ONumber | olympe.df.OBoolean | olympe.df.Color | olympe.df.ODateTime | olympe.dc.Reference | string | number | boolean | olympe.df.Node | olympe.df.Proxy <nullable>
Returns:

this

Type
olympe.dc.transaction.operations.UpdateInstance

setVersion(version)

Sets the new instance version

Parameters:
Name Type Description
version number