Interface ObjectOperation

An operation that was applied to an object on a channel.

Hierarchy

  • ObjectOperation

Properties

The operation action, one of the ObjectOperationAction enum values.

counter?: ObjectsCounter

The payload for the operation if the action is COUNTER_CREATE. Defines the initial value of the counter object.

Deprecated

This property is deprecated and will be removed in a future major version. Use counterCreate instead.

counterCreate?: CounterCreate

The payload for the operation if the action is COUNTER_CREATE. Defines the initial value of the counter object.

counterInc?: CounterInc

The payload for the operation if the action is COUNTER_INC. Describes the value to add to the counter.

counterOp?: ObjectsCounterOp

The payload for the operation if it is a mutation operation on a counter object.

Deprecated

This property is deprecated and will be removed in a future major version. Use counterInc instead.

map?: ObjectsMap

The payload for the operation if the action is MAP_CREATE. Defines the initial value of the map object.

Deprecated

This property is deprecated and will be removed in a future major version. Use mapCreate instead.

mapClear?: MapClear

The payload for the operation if the action is MAP_CLEAR.

mapCreate?: MapCreate

The payload for the operation if the action is MAP_CREATE. Defines the initial value of the map object.

mapOp?: ObjectsMapOp

The payload for the operation if it is a mutation operation on a map object.

Deprecated

This property is deprecated and will be removed in a future major version. Use mapSet and mapRemove instead.

mapRemove?: MapRemove

The payload for the operation if the action is MAP_REMOVE. Describes the key to remove from the map object.

mapSet?: MapSet

The payload for the operation if the action is MAP_SET. Describes the key and value to set on the map object.

objectDelete?: ObjectDelete

The payload for the operation if the action is OBJECT_DELETE.

objectId: string

The ID of the object the operation was applied to.

Generated using TypeDoc