Packages > @fluidframework/odsp-driver-definitions
@fluidframework/odsp-driver-definitions Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| HostStoragePolicy |
ALPHA
|
|
| ICacheEntry |
ALPHA
|
Cache entry. Identifies file that this entry belongs to, and type of content stored in it. |
| ICollabSessionOptions |
ALPHA
|
|
| IEntry |
ALPHA
|
Cache entry. Identifies file that this entry belongs to, and type of content stored in it. |
| IFileEntry |
ALPHA
|
|
| IOdspResolvedUrl |
ALPHA
|
|
| IOdspUrlParts |
ALPHA
|
|
| IOpsCachingPolicy |
ALPHA
|
|
| IPersistedCache |
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 |
ALPHA
|
An interface that allows a concrete instance of a driver factory to interrogate itself to find out if it is session aware. |
| IRelaySessionAwareDriverFactory |
ALPHA
|
An interface that allows a concrete instance of a driver factory to call the getRelayServiceSessionInfo function if it session aware.
|
| ISharingLink |
ALPHA
|
Sharing link data received from the /snapshot api response. |
| ISharingLinkKind |
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 |
ALPHA
|
|
| ISocketStorageDiscovery |
ALPHA
|
Socket storage discovery api response |
| OdspResourceTokenFetchOptions |
ALPHA
|
Represents access token fetch options for ODSP resource |
| ShareLinkInfoType |
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 |
ALPHA
|
Represents access token fetch options |
| TokenResponse |
ALPHA
|
Represents token response |
Enumerations
| Enum | Alerts | Description |
|---|---|---|
| ShareLinkTypes |
ALPHA, DEPRECATED
|
|
| SharingLinkRole |
ALPHA
|
View/edit permission role for a sharing link. |
| SharingLinkScope |
ALPHA
|
Sharing scope of the share links created for a file. |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| CacheContentType |
ALPHA
|
|
| TokenFetcher |
ALPHA
|
Method signature for callback method used to fetch access token |
Type Details
CacheContentType (ALPHA)
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type CacheContentType = "snapshot" | "ops";
TokenFetcher (ALPHA)
Method signature for callback method used to fetch access token
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;