@fluidframework/odsp-driver-definitions Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| HostStoragePolicy | Legacy, Alpha |
|
| ICacheEntry | Legacy, Alpha |
Cache entry. Identifies file that this entry belongs to, and type of content stored in it. |
| ICollabSessionOptions | Legacy, Alpha |
|
| IEntry | Legacy, Alpha |
Cache entry. Identifies file that this entry belongs to, and type of content stored in it. |
| IFileEntry | Legacy, Alpha |
|
| IOdspError | Legacy, Alpha |
Base interface for all errors and warnings Superset of IDriverErrorBase, but with Odsp-specific errorType and properties |
| IOdspErrorAugmentations | Legacy, Alpha |
|
| IOdspResolvedUrl | Legacy, Alpha |
|
| IOdspUrlParts | Legacy, Alpha |
|
| IOpsCachingPolicy | Legacy, Alpha |
|
| IPersistedCache | Legacy, Alpha |
Persistent 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. |
| IProvideSessionAwareDriverFactory | Legacy, Alpha |
An interface that allows a concrete instance of a driver factory to interrogate itself to find out if it is session aware. |
| IRelaySessionAwareDriverFactory | Legacy, Alpha |
An interface that allows a concrete instance of a driver factory to call the getRelayServiceSessionInfo function if it session aware. |
| ISharingLink | Legacy, Alpha |
Sharing link data received from the /snapshot api response. |
| ISharingLinkKind | Legacy, Alpha |
Defines 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. |
| ISnapshotOptions | Legacy, Alpha |
|
| ISocketStorageDiscovery | Legacy, Alpha |
Socket storage discovery api response |
| OdspResourceTokenFetchOptions | Legacy, Alpha |
Represents access token fetch options for ODSP resource |
| ShareLinkInfoType | Legacy, Alpha |
Sharing 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 |
| TokenFetchOptions | Legacy, Alpha |
Represents access token fetch options |
| TokenResponse | Legacy, Alpha |
Represents token response |
Enumerations
| Enum | Alerts | Description |
|---|---|---|
| SharingLinkRole | Legacy, Alpha |
View/edit permission role for a sharing link. |
| SharingLinkScope | Legacy, Alpha |
Sharing scope of the share links created for a file. |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| CacheContentType | Legacy, Alpha |
|
| IdentityType | Legacy, Alpha |
Identity types supported by ODSP driver. Consumer represents user authenticated with Microsoft Account (MSA). Enterprise represents user authenticated with M365 tenant account. |
| OdspError | Legacy, Alpha |
|
| OdspErrorTypes | Legacy, Alpha |
|
| TokenFetcher | Legacy, Alpha |
Method signature for callback method used to fetch access token |
Variables
| Variable | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| OdspErrorTypes | Legacy, Alpha |
readonly |
{ 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.
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"; }