ISerializableInterval Interface
Packages > fluid-framework > ISerializableInterval
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. |
| propertyManager | Deprecated, Alpha |
PropertiesManager |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| addProperties(props, collaborating, seq) | Deprecated, Alpha |
PropertySet | undefined | |
| getIntervalId() | Alpha |
string | undefined | 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
propertyManager
This API is deprecated and will be removed in a future release.
- This property should not be used externally and will be removed in a subsequent release.
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
propertyManager: PropertiesManager;
Type: PropertiesManager
Method Details
addProperties
This API is deprecated and will be removed in a future release.
- This function should not be used externally and will be removed in a subsequent release.
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
addProperties(props: PropertySet, collaborating?: boolean, seq?: number): PropertySet | undefined;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| props | PropertySet | ||
| collaborating | optional | boolean | |
| seq | optional | number |
Returns
Return type: PropertySet | undefined
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 | undefined;
Remarks
This signature includes undefined strictly for backwards-compatibility reasons, as older versions of Fluid didn’t always write interval ids.
Returns
Return type: string | undefined
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