Skip to main content

IOdspResolvedUrl 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 IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts

Extends: IResolvedUrl, IOdspUrlParts

Properties​

Property Alerts Modifiers Type Description
codeHint Alpha optional { containerPackageName?: string; }
dataStorePath Alpha optional string
endpoints Alpha { snapshotStorageUrl: string; attachmentPOSTStorageUrl: string; attachmentGETStorageUrl: string; deltaStorageUrl: string; }
fileName Alpha string
fileVersion Alpha string | undefined
hashedDocumentId Alpha string
isClpCompliantApp Alpha optional boolean
odspResolvedUrl Alpha true
shareLinkInfo Alpha optional ShareLinkInfoType 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
summarizer Alpha boolean
tokens Alpha {}
type Alpha "fluid"
url Alpha string

Property Details​

codeHint​

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​

codeHint?: {
        containerPackageName?: string;
    };

Type: { containerPackageName?: string; }

dataStorePath​

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​

dataStorePath?: string;

Type: string

endpoints​

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​

endpoints: {
        snapshotStorageUrl: string;
        attachmentPOSTStorageUrl: string;
        attachmentGETStorageUrl: string;
        deltaStorageUrl: string;
    };

Type: { snapshotStorageUrl: string; attachmentPOSTStorageUrl: string; attachmentGETStorageUrl: string; deltaStorageUrl: string; }

fileName​

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​

fileName: string;

Type: string

fileVersion​

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​

fileVersion: string | undefined;

Type: string | undefined

hashedDocumentId​

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​

hashedDocumentId: string;

Type: string

isClpCompliantApp​

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​

isClpCompliantApp?: boolean;

Type: boolean

odspResolvedUrl​

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​

odspResolvedUrl: true;

Type: true

shareLinkInfo​

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

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​

shareLinkInfo?: ShareLinkInfoType;

Type: ShareLinkInfoType

summarizer​

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​

summarizer: boolean;

Type: boolean

tokens​

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​

tokens: {};

Type: {}

type​

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​

type: "fluid";

Type: "fluid"

url​

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​

url: string;

Type: string