Skip to main content

IFileEntry Interface

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

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

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

Signature​

export interface IFileEntry

Properties​

Property Alerts Type Description
docId Alpha string Unique and stable ID of the document. Driver guarantees that docId is stable ID uniquely identifying document.
resolvedUrl Alpha 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 as an alpha preview and may change without notice.

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

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

Signature​

docId: 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 as an alpha preview and may change without notice.

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

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

Signature​

resolvedUrl: IResolvedUrl;

Type: IResolvedUrl