SharedStringFactory Class
Signature
export declare class SharedStringFactory implements IChannelFactory
Implements: IChannelFactory
Static Properties
| Property | Type | Description |
|---|---|---|
| Attributes | IChannelAttributes | |
| Type | string |
Static Methods
| Method | Return Type | Description |
|---|---|---|
| segmentFromSpec(spec) | SharedStringSegment |
Properties
| Property | Type | Description |
|---|---|---|
| attributes | IChannelAttributes | |
| type | string |
Methods
| Method | Return Type | Description |
|---|---|---|
| create(document, id) | SharedString | |
| load(runtime, id, services, attributes) | Promise<SharedString> | Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel. |
Property Details
attributes
Signature
get attributes(): IChannelAttributes;
Type: IChannelAttributes
Attributes
Signature
static readonly Attributes: IChannelAttributes;
Type: IChannelAttributes
type
Signature
get type(): string;
Type: string
Type
Signature
static Type: string;
Type: string
Method Details
create
Signature
create(document: IFluidDataStoreRuntime, id: string): SharedString;
Parameters
| Parameter | Type | Description |
|---|---|---|
| document | IFluidDataStoreRuntime | |
| id | string |
Returns
Return type: SharedString
load
Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel.
Signature
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<SharedString>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| runtime | IFluidDataStoreRuntime | Data store runtime containing state/info/helper methods about the data store. |
| id | string | ID of the channel. |
| services | IChannelServices | Services to read objects at a given path using the delta connection. |
| attributes | IChannelAttributes |
Returns
The loaded object
Return type: Promise<SharedString>
segmentFromSpec
Signature
static segmentFromSpec(spec: any): SharedStringSegment;
Parameters
| Parameter | Type | Description |
|---|---|---|
| spec | any |
Returns
Return type: SharedStringSegment