Skip to main content
Version: v1

IFileEntry Interface

Signature​

export interface IFileEntry

Properties​

PropertyTypeDescription
docIdstringUnique and stable ID of the document. Driver guarantees that docId is stable ID uniquely identifying document.
resolvedUrlIFluidResolvedUrlResolved 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.

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.

Signature​

resolvedUrl: IFluidResolvedUrl;

Type: IFluidResolvedUrl