Olympe SDK

Class: DeleteAllRelations

olympe.dc.transaction.operations. DeleteAllRelations

Operation that delete all relation(s) from an instance for a given modRel

new DeleteAllRelations(relation, leftTag [, deleteSyncs] [, exceptions])

Creates a DeleteAllRelations operation instance.

Parameters:
Name Type Argument Default Description
relation olympe.dc.InstanceTag | olympe.dc.registry.Relation
leftTag olympe.dc.InstanceTag
deleteSyncs boolean <optional>
 false
exceptions Array.<olympe.dc.InstanceTag> <optional>

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, *>

getDirection()

Gets the relation direction

Returns:
Type
olympe.dc.Direction

getLeftTag()

Gets the left tag

Returns:
Type
string

getType()

Gets the relation type

Returns:
Type
string