Skip to main content

MapFactory Class

IChannelFactory for ISharedMap.

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

To use, import via @fluidframework/map/legacy.

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

Signature

/** @sealed */
export declare class MapFactory implements IChannelFactory<ISharedMap>

Implements: IChannelFactory<ISharedMap>

Static Properties

Property Alerts Modifiers Type Description
Attributes Alpha readonly IChannelAttributes Attributes of the channel.
Type Alpha readonly String representing the type of the factory.

Properties

Property Alerts Modifiers Type Description
attributes Alpha readonly IChannelAttributes Attributes of the channel.
type Alpha readonly string String representing the type of the factory.

Property Details

attributes

Attributes of the channel.

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

To use, import via @fluidframework/map/alpha.

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

Signature

get attributes(): IChannelAttributes;

Type: IChannelAttributes

Attributes

Attributes of the channel.

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

To use, import via @fluidframework/map/alpha.

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

Signature

static readonly Attributes: IChannelAttributes;

Type: IChannelAttributes

type

String representing the type of the factory.

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

To use, import via @fluidframework/map/alpha.

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

Signature

get type(): string;

Type: string

Type

String representing the type of the factory.

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

To use, import via @fluidframework/map/alpha.

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

Signature

static readonly Type = "https://graph.microsoft.com/types/map";