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
appName Alpha optional string Name of the application that owns the URL. This hint is used by link handling logic which determines which app to redirect to when user navigates directly to the link. Can be ommited in case it is not necessary for the link handling logic.
codeHint Alpha optional { containerPackageName?: string; }
context Alpha optional string Context for given resolved URL. The context of a resolved URL is a string that contains the resolved URL and the data store path of the resolved URL.
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
pendingRename Alpha optional string Used to track when a file was created with a temporary name. In that case this value will be the desired name, which the file is eventually renamed too.
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​

appName​

Name of the application that owns the URL. This hint is used by link handling logic which determines which app to redirect to when user navigates directly to the link. Can be ommited in case it is not necessary for the link handling logic.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

appName?: string;

Type: string

codeHint​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

codeHint?: {
        containerPackageName?: string;
    };

Type: { containerPackageName?: string; }

context​

Context for given resolved URL. The context of a resolved URL is a string that contains the resolved URL and the data store path of the resolved URL.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

context?: string;

Type: string

dataStorePath​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

dataStorePath?: string;

Type: string

endpoints​

This API is provided for existing users, but is not recommended for new users.

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 for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

fileName: string;

Type: string

fileVersion​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

fileVersion: string | undefined;

Type: string | undefined

hashedDocumentId​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

hashedDocumentId: string;

Type: string

isClpCompliantApp​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

isClpCompliantApp?: boolean;

Type: boolean

odspResolvedUrl​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

odspResolvedUrl: true;

Type: true

pendingRename​

Used to track when a file was created with a temporary name. In that case this value will be the desired name, which the file is eventually renamed too.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

pendingRename?: string;

Type: string

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 for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

shareLinkInfo?: ShareLinkInfoType;

Type: ShareLinkInfoType

summarizer​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

summarizer: boolean;

Type: boolean

tokens​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

tokens: {};

Type: {}

type​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

type: "fluid";

Type: "fluid"

url​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

url: string;

Type: string