IAttributionCollectionSerializer Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/merge-tree/legacy.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface IAttributionCollectionSerializer

Methods

Method	Alerts	Return Type	Description
populateAttributionCollections(segments, summary)	Alpha	void	Populates attribution information on segments using the provided summary.
serializeAttributionCollections(segments)	Alpha	SerializedAttributionCollection

Method Details

populateAttributionCollections

Populates attribution information on segments using the provided summary.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

populateAttributionCollections(segments: Iterable<ISegment>, summary: SerializedAttributionCollection): void;

Parameters

Parameter	Type	Description
segments	Iterable<ISegment>
summary	SerializedAttributionCollection

serializeAttributionCollections

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

serializeAttributionCollections(segments: Iterable<{
        attribution?: IAttributionCollection<AttributionKey>;
        cachedLength: number;
    }>): SerializedAttributionCollection;

Parameters

Parameter	Type	Description
segments	Iterable<{ attribution?: IAttributionCollection<AttributionKey>; cachedLength: number; }>

Returns

Return type: SerializedAttributionCollection