Skip to main content

@fluidframework/odsp-driver-definitions Package

Interfaces​

InterfaceAlertsDescription
HostStoragePolicyLegacy
ICacheEntryDeprecated, LegacyCache entry. Identifies file that this entry belongs to, and type of content stored in it.
ICollabSessionOptionsLegacy
IEntryDeprecated, LegacyCache entry. Identifies file that this entry belongs to, and type of content stored in it.
IFileEntryDeprecated, Legacy
IOdspErrorLegacyBase interface for all errors and warnings Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
IOdspErrorAugmentationsLegacy
IOdspResolvedUrlLegacy
IOdspUrlPartsLegacy
IOpsCachingPolicyLegacy
IPersistedCacheDeprecated, LegacyPersistent cache. This interface can be implemented by the host to provide durable caching across sessions. If not provided at driver factory construction, factory will use in-memory cache implementation that does not survive across sessions. Snapshot entires stored in the IPersistedCache will be considered stale and removed after 2 days. Read the README for more information.
IProvideSessionAwareDriverFactoryLegacyAn interface that allows a concrete instance of a driver factory to interrogate itself to find out if it is session aware.
IRelaySessionAwareDriverFactoryLegacyAn interface that allows a concrete instance of a driver factory to call the getRelayServiceSessionInfo function if it session aware.
ISensitivityLabelLegacyA single sensitivity label applied to a document, part of the socket storage discovery response.
ISensitivityLabelsInfoLegacySensitivity labels information for a file, part of the socket storage discovery response.
ISharingLinkLegacySharing link data received from the /snapshot api response.
ISharingLinkKindLegacyDefines the permissions scope for a share link requested to be created during the creation the file in ODSP. Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
ISnapshotOptionsLegacy
ISocketStorageDiscoveryLegacySocket storage discovery api response
OdspResourceTokenFetchOptionsLegacyRepresents access token fetch options for ODSP resource
ShareLinkInfoTypeLegacySharing link data created for the ODSP item. Contains information about either sharing link created while creating a new file or a redeemable share link created when loading an existing file
TokenFetchOptionsLegacyRepresents access token fetch options
TokenResponseLegacyRepresents token response

Enumerations​

EnumAlertsDescription
SharingLinkRoleLegacyView/edit permission role for a sharing link.
SharingLinkScopeLegacySharing scope of the share links created for a file.

Types​

TypeAliasAlertsDescription
CacheContentTypeLegacy
IdentityTypeLegacyIdentity types supported by ODSP driver. Consumer represents user authenticated with Microsoft Account (MSA). Enterprise represents user authenticated with M365 tenant account.
OdspErrorLegacy
OdspErrorTypesLegacy
TokenFetcherLegacyMethod signature for callback method used to fetch access token

Variables​

VariableAlertsModifiersTypeDescription
OdspErrorTypesLegacyreadonly{ readonly invalidFileNameError: "invalidFileNameError"; readonly snapshotTooBig: "snapshotTooBig"; readonly fetchTimeout: "fetchTimeout"; readonly fluidNotEnabled: "fluidNotEnabled"; readonly cannotCatchUp: "cannotCatchUp"; readonly serviceReadOnly: "serviceReadOnly"; readonly blockedIPAddress: "blockedIPAddress"; readonly genericNetworkError: "genericNetworkError"; readonly authorizationError: "authorizationError"; readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError"; readonly offlineError: "offlineError"; readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion"; readonly writeError: "writeError"; readonly fetchFailure: "fetchFailure"; readonly fetchTokenError: "fetchTokenError"; readonly incorrectServerResponse: "incorrectServerResponse"; readonly fileOverwrittenInStorage: "fileOverwrittenInStorage"; readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden"; readonly locationRedirection: "locationRedirection"; readonly fluidInvalidSchema: "fluidInvalidSchema"; readonly fileIsLocked: "fileIsLocked"; readonly outOfStorageError: "outOfStorageError"; readonly genericError: "genericError"; readonly throttlingError: "throttlingError"; readonly usageError: "usageError"; }ODSP Error types. Different error types that may be thrown by the ODSP driver.

Variable Details​

OdspErrorTypes​

ODSP Error types. Different error types that may be thrown by the ODSP driver.

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​

OdspErrorTypes: {
    readonly invalidFileNameError: "invalidFileNameError";
    readonly snapshotTooBig: "snapshotTooBig";
    readonly fetchTimeout: "fetchTimeout";
    readonly fluidNotEnabled: "fluidNotEnabled";
    readonly cannotCatchUp: "cannotCatchUp";
    readonly serviceReadOnly: "serviceReadOnly";
    readonly blockedIPAddress: "blockedIPAddress";
    readonly genericNetworkError: "genericNetworkError";
    readonly authorizationError: "authorizationError";
    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
    readonly offlineError: "offlineError";
    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
    readonly writeError: "writeError";
    readonly fetchFailure: "fetchFailure";
    readonly fetchTokenError: "fetchTokenError";
    readonly incorrectServerResponse: "incorrectServerResponse";
    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
    readonly locationRedirection: "locationRedirection";
    readonly fluidInvalidSchema: "fluidInvalidSchema";
    readonly fileIsLocked: "fileIsLocked";
    readonly outOfStorageError: "outOfStorageError";
    readonly genericError: "genericError";
    readonly throttlingError: "throttlingError";
    readonly usageError: "usageError";
}

Type: { readonly invalidFileNameError: "invalidFileNameError"; readonly snapshotTooBig: "snapshotTooBig"; readonly fetchTimeout: "fetchTimeout"; readonly fluidNotEnabled: "fluidNotEnabled"; readonly cannotCatchUp: "cannotCatchUp"; readonly serviceReadOnly: "serviceReadOnly"; readonly blockedIPAddress: "blockedIPAddress"; readonly genericNetworkError: "genericNetworkError"; readonly authorizationError: "authorizationError"; readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError"; readonly offlineError: "offlineError"; readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion"; readonly writeError: "writeError"; readonly fetchFailure: "fetchFailure"; readonly fetchTokenError: "fetchTokenError"; readonly incorrectServerResponse: "incorrectServerResponse"; readonly fileOverwrittenInStorage: "fileOverwrittenInStorage"; readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden"; readonly locationRedirection: "locationRedirection"; readonly fluidInvalidSchema: "fluidInvalidSchema"; readonly fileIsLocked: "fileIsLocked"; readonly outOfStorageError: "outOfStorageError"; readonly genericError: "genericError"; readonly throttlingError: "throttlingError"; readonly usageError: "usageError"; }