OdspConnectionConfig Interface

Defines the necessary properties that will be applied to all containers created by an OdspClient instance. This includes callbacks for the authentication tokens required for ODSP.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

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

Signature

export interface OdspConnectionConfig

Properties

Property	Alerts	Type	Description
driveId	Beta	string	SharePoint Embedded Container Id of the tenant where Fluid containers are created
filePath	Beta	string	Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.
siteUrl	Beta	string	Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.
tokenProvider	Beta	IOdspTokenProvider	Instance that provides AAD endpoint tokens for Push and SharePoint

Property Details

driveId

SharePoint Embedded Container Id of the tenant where Fluid containers are created

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

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

Signature

driveId: string;

Type: string

filePath

Specifies the file path where Fluid files are created. If passed an empty string, the Fluid files will be created at the root level.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

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

Signature

filePath: string;

Type: string

siteUrl

Site url representing ODSP resource location. It points to the specific SharePoint site where you can store and access the containers you create.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

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

Signature

siteUrl: string;

Type: string

tokenProvider

Instance that provides AAD endpoint tokens for Push and SharePoint

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

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

Signature

tokenProvider: IOdspTokenProvider;

Type: IOdspTokenProvider