MergableObjectWithState <P>

Describes the relation between a local object and its remote counterpart. Also gives the state for the local object and (if exists) a conflict reason between the local and the remote object. A conflict typically arises when the local object has been modified and so has the remote object. Example: local object was modified but remote object was deleted. This conflict cannot be resolved automatically.

Index

Constructors

• constructor

Properties

• local
• onStateChange
• remote

Accessors

• conflictReason
• hasConflict
• state

Constructors

publicconstructor

• new MergableObjectWithState<P>(local: P, _state: MergableObjectState, _conflictReason: MergableObjectConflict, remote?: P): MergableObjectWithState<P>

• Type parameters

  • P

  Parameters

  • local: P

    local object.

  • _state: MergableObjectState

  • _conflictReason: MergableObjectConflict

  • optionalremote: P

    Remote object (if there is one)

  Returns MergableObjectWithState<P>

Properties

publiclocal

local: P

local object.

publiconStateChange

onStateChange: (p: MergableObjectWithState<P>) => void

Type declaration

• • (p: MergableObjectWithState<P>): void

  • Parameters

    • p: MergableObjectWithState<P>

    Returns void

publicoptionalremote

remote?: P

Remote object (if there is one)

Accessors

publicconflictReason

• get conflictReason(): MergableObjectConflict
• set conflictReason(v: MergableObjectConflict): void

• If defined then there is a conflict between the local and the remote object.

  ---

  Returns MergableObjectConflict

• Sets conflict reason (if any).

  ---

  Parameters

  • v: MergableObjectConflict

  Returns void

publichasConflict

• get hasConflict(): boolean

• true if a conflict exists. Otherwise false

  ---

  Returns boolean

publicstate

• get state(): MergableObjectState
• set state(v: MergableObjectState): void

• get current state of the local object.

  ---

  Returns MergableObjectState

• set current state of the local object.

  ---

  Parameters

  • v: MergableObjectState

  Returns void