Packages > @fluid-experimental/odsp-client > OdspConnectionConfig

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.

WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.

Signature

export interface OdspConnectionConfig

Properties

Property Alerts Type Description
driveId BETA string RaaS Drive 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 (BETA)

RaaS Drive Id of the tenant where Fluid containers are created

WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.

Signature

driveId: string;

filePath (BETA)

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

WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.

Signature

filePath: string;

siteUrl (BETA)

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

WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.

Signature

siteUrl: string;

tokenProvider (BETA)

Instance that provides AAD endpoint tokens for Push and SharePoint

WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.

Signature

tokenProvider: IOdspTokenProvider;