IChannel Interface

Packages > @fluidframework/datastore-definitions > IChannel

Signature:

export interface IChannel extends IProvideChannel, IFluidLoadable

Extends: IProvideChannel, IFluidLoadable

Properties

List of properties of this interface
Property Type Description
attributes IChannelAttributes
id string A readonly identifier for the channel
owner string

Methods

List of methods of this class
Method Description
connect(services) Enables the channel to send and receive ops
isAttached() True if the data structure is attached to storage.
snapshot() Generates snapshot of the channel.

Events

attributes

Signature:

readonly attributes: IChannelAttributes;

id

A readonly identifier for the channel

Signature:

readonly id: string;

owner

Signature:

readonly owner?: string;

Methods

connect

Enables the channel to send and receive ops

Signature:

connect(services: IChannelServices): void;

Parameters

List of parameters
Parameter Type Description
services IChannelServices

Returns:

void

isAttached

True if the data structure is attached to storage.

Signature:

isAttached(): boolean;

Returns:

boolean

snapshot

Generates snapshot of the channel.

Signature:

snapshot(): ITree;

Returns:

ITree