Skip to main content

IFileEntry Interface

File / container identifier. There is overlapping information here - host can use all of it or parts to implement storage / identify files. \

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

To use, import via @fluidframework/driver-definitions/legacy.

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

Signature

export interface IFileEntry

Properties

Property Alerts Modifiers Type Description
docId Beta string Unique and stable ID of the document. Driver guarantees that docId is stable ID uniquely identifying document.
fileVersion Beta optional string Optional version of the file.
resolvedUrl Beta IResolvedUrl Resolved URI is provided for additional versatility - host can use it to identify file in storage, and (as example) delete all cached entries for a file if user requests so. This is IOdspResolvedUrl in case of ODSP driver.

Property Details

docId

Unique and stable ID of the document. Driver guarantees that docId is stable ID uniquely identifying document.

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
docId: string;

Type: string

fileVersion

Optional version of the file.

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
fileVersion?: string;

Type: string

resolvedUrl

Resolved URI is provided for additional versatility - host can use it to identify file in storage, and (as example) delete all cached entries for a file if user requests so. This is IOdspResolvedUrl in case of ODSP driver.

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
resolvedUrl: IResolvedUrl;

Type: IResolvedUrl