Package io.ably.lib.liveobjects.message

Interface ObjectOperation

public interface ObjectOperation
The user-facing representation of an operation applied to an object on a channel. It is exposed as the operation attribute of an ObjectMessage.

Exactly one of the payload accessors (getMapCreate(), getMapSet(), getMapRemove(), getCounterCreate(), getCounterInc(), getObjectDelete(), getMapClear()) returns a non-null value, corresponding to the action of the operation.

Note that, unlike the wire-level operation representation, this type does not carry the outbound-only mapCreateWithObjectId / counterCreateWithObjectId variants: those are resolved back to their derived MapCreate / CounterCreate forms before being surfaced to users.

Spec: PAOOP1, PAOOP2

  • Method Details

    • getAction

      @NotNull @NotNull ObjectOperationAction getAction()
      Returns the action of this operation, defining what was applied to the object.

      Spec: PAOOP2a / OOP3a

      Returns:
      the operation action

    • getObjectId

      @NotNull @NotNull String getObjectId()
      Returns the object id of the object on the channel to which this operation was applied.

      Spec: PAOOP2b / OOP3b

      Returns:
      the target object id

    • getMapCreate

      @Nullable @Nullable MapCreate getMapCreate()
      Returns the payload of a ObjectOperationAction.MAP_CREATE operation.

      Spec: PAOOP2c / OOP3j

      Returns:
      the map-create payload, or null if not applicable

    • getMapSet

      @Nullable @Nullable MapSet getMapSet()
      Returns the payload of a ObjectOperationAction.MAP_SET operation.

      Spec: PAOOP2d / OOP3k

      Returns:
      the map-set payload, or null if not applicable

    • getMapRemove

      @Nullable @Nullable MapRemove getMapRemove()
      Returns the payload of a ObjectOperationAction.MAP_REMOVE operation.

      Spec: PAOOP2e / OOP3l

      Returns:
      the map-remove payload, or null if not applicable

    • getCounterCreate

      @Nullable @Nullable CounterCreate getCounterCreate()
      Returns the payload of a ObjectOperationAction.COUNTER_CREATE operation.

      Spec: PAOOP2f / OOP3m

      Returns:
      the counter-create payload, or null if not applicable

    • getCounterInc

      @Nullable @Nullable CounterInc getCounterInc()
      Returns the payload of a ObjectOperationAction.COUNTER_INC operation.

      Spec: PAOOP2g / OOP3n

      Returns:
      the counter-increment payload, or null if not applicable

    • getObjectDelete

      @Nullable @Nullable ObjectDelete getObjectDelete()
      Returns the payload of an ObjectOperationAction.OBJECT_DELETE operation.

      Spec: PAOOP2h / OOP3o

      Returns:
      the object-delete payload, or null if not applicable

    • getMapClear

      @Nullable @Nullable MapClear getMapClear()
      Returns the payload of a ObjectOperationAction.MAP_CLEAR operation.

      Spec: PAOOP2i / OOP3r

      Returns:
      the map-clear payload, or null if not applicable