ISocketStorageDiscovery Interface

Socket storage discovery api response

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 ISocketStorageDiscovery

Properties

Property	Alerts	Modifiers	Type	Description
deltaStorageUrl	Alpha		string
deltaStreamSocketUrl	Alpha		string	PUSH URL
id	Alpha		string
refreshSessionDurationSeconds	Alpha	optional	number	This is the time within which client has to refresh the session on (ODSP) relay service.
runtimeTenantId	Alpha	optional	string
sensitivityLabelsInfo	Alpha	optional	string	Represent the sensitivity labels info for the file. Keeping it optional for back-compat. The response will contain empty labels when the file has no labels, so this field will be there even if file has no labels when the service will implement this contract.
snapshotStorageUrl	Alpha		string
socketToken	Alpha	optional	string	The access token for PushChannel. Optionally returned, depending on implementation. OneDrive for Consumer implementation returns it and OneDrive for Business implementation does not return it and instead expects token to be returned via getWebsocketToken callback passed as a parameter to OdspDocumentService.create() factory.
tenantId	Alpha		string

Property Details

deltaStorageUrl

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

deltaStorageUrl: string;

Type: string

deltaStreamSocketUrl

PUSH 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

deltaStreamSocketUrl: string;

Type: string

id

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

id: string;

Type: string

refreshSessionDurationSeconds

This is the time within which client has to refresh the session on (ODSP) relay service.

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

refreshSessionDurationSeconds?: number;

Type: number

runtimeTenantId

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

runtimeTenantId?: string;

Type: string

sensitivityLabelsInfo

Represent the sensitivity labels info for the file. Keeping it optional for back-compat. The response will contain empty labels when the file has no labels, so this field will be there even if file has no labels when the service will implement this contract.

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

sensitivityLabelsInfo?: string;

Type: string

snapshotStorageUrl

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

snapshotStorageUrl: string;

Type: string

socketToken

The access token for PushChannel. Optionally returned, depending on implementation. OneDrive for Consumer implementation returns it and OneDrive for Business implementation does not return it and instead expects token to be returned via getWebsocketToken callback passed as a parameter to OdspDocumentService.create() factory.

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

socketToken?: string;

Type: string

tenantId

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

tenantId: string;

Type: string