IFluidObjectMapItem Interface

Packages > @fluidframework/react > IFluidObjectMapItem

The values stored in the Fluid object map

Signature:

export interface IFluidObjectMapItem 

Properties

List of properties of this interface
Property Type Description
fluidObject IFluidObject & IFluidLoadable The actual Fluid object that the path this value is keyed against leads to
isListened boolean Boolean indicating if we are listening to changes on this Fluid object's synced state to trigger React state updates. Only set if you want custom behavior for adding listeners to your Fluid state
isRuntimeMap boolean INTERNAL Does not need to be set Is this a SharedMap that was added as a Fluid React requirement
listenedEvents string[] List of events fired on this Fluid object that will trigger a state update

Events

fluidObject

The actual Fluid object that the path this value is keyed against leads to

Signature:

fluidObject?: IFluidObject & IFluidLoadable;

isListened

Boolean indicating if we are listening to changes on this Fluid object’s synced state to trigger React state updates. Only set if you want custom behavior for adding listeners to your Fluid state

Signature:

isListened?: boolean;

isRuntimeMap

INTERNAL Does not need to be set Is this a SharedMap that was added as a Fluid React requirement

Signature:

isRuntimeMap?: boolean;

listenedEvents

List of events fired on this Fluid object that will trigger a state update

Signature:

listenedEvents?: string[];