Skip to main content

ISerializableInterval Interface

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

To use, import via fluid-framework/legacy.

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

Signature​

export interface ISerializableInterval extends IInterval

Extends: IInterval

Properties​

Property Alerts Type Description
properties Alpha PropertySet Serializable bag of properties associated with the interval.

Methods​

Method Alerts Return Type Description
getIntervalId() Alpha string Gets the id associated with this interval. When the interval is used as part of an interval collection, this id can be used to modify or remove the interval.
serialize() Alpha ISerializedInterval

Property Details​

properties​

Serializable bag of properties associated with the interval.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

properties: PropertySet;

Type: PropertySet

Method Details​

getIntervalId​

Gets the id associated with this interval. When the interval is used as part of an interval collection, this id can be used to modify or remove the interval.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

getIntervalId(): string;

Returns​

Return type: string

serialize​

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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

Signature​

serialize(): ISerializedInterval;

Returns​

Return type: ISerializedInterval