IChannelAttributes Interface
Represents the attributes of a channel/DDS.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/datastore-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IChannelAttributes
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| packageVersion | Alpha |
optional, readonly |
string | The package version of the code of the DDS, for debug only |
| snapshotFormatVersion | Alpha |
readonly |
string | Format version of the snapshot Currently, only use to display a debug message if the version is incompatible |
| type | Alpha |
readonly |
string | Type name of the DDS for factory look up with ISharedObjectRegistry |
Property Details
packageVersion
The package version of the code of the DDS, for debug only
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly packageVersion?: string;
Type: string
snapshotFormatVersion
Format version of the snapshot Currently, only use to display a debug message if the version is incompatible
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly snapshotFormatVersion: string;
Type: string
type
Type name of the DDS for factory look up with ISharedObjectRegistry
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly type: string;
Type: string