SharedStringFactory Class
Packages > @fluidframework/sequence > SharedStringFactory
Signature:
export declare class SharedStringFactory implements IChannelFactory
Implements: IChannelFactory
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| attributes | IChannelAttributes | ||
| Attributes | static |
IChannelAttributes | |
| type | string | ||
| Type | static |
string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| create(document, id) | ||
| load(runtime, id, services, attributes) | 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. | |
| segmentFromSpec(spec) | static |
Properties
attributes
Signature:
get attributes(): IChannelAttributes;
Attributes
Signature:
static readonly Attributes: IChannelAttributes;
type
Signature:
get type(): string;
Type
Signature:
static Type: string;
Methods
create
Signature:
create(document: IFluidDataStoreRuntime, id: string): SharedString;
Parameters
| Parameter | Type | Description |
|---|---|---|
| document | IFluidDataStoreRuntime | |
| id | string |
Returns:
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:
Promise<SharedString>
The loaded object
segmentFromSpec
Signature:
static segmentFromSpec(spec: any): import("./sharedString").SharedStringSegment;
Parameters
| Parameter | Type | Description |
|---|---|---|
| spec | any |
Returns:
import("./sharedString").SharedStringSegment