Skip to main content

@fluidframework/odsp-doclib-utils Package

Interfaces

Interface Alerts Description
IOdspAuthRequestInfo Legacy

Functions

Function Alerts Return Type Description
getDriveId(server, account, library, authRequestInfo) Legacy Promise<string>
getOdspScope(server) Legacy string

Variables

Variable Alerts Modifiers Type Description
pushScope Legacy readonly

Function Details

getDriveId

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

To use, import via @fluidframework/odsp-doclib-utils/legacy.

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

Signature

export declare function getDriveId(server: string, account: string, library: string | undefined, authRequestInfo: IOdspAuthRequestInfo): Promise<string>;

Parameters

Parameter Type Description
server string
account string
library string | undefined
authRequestInfo IOdspAuthRequestInfo

Returns

Return type: Promise<string>

getOdspScope

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

To use, import via @fluidframework/odsp-doclib-utils/legacy.

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

Signature

getOdspScope: (server: string) => string

Parameters

Parameter Type Description
server string

Returns

Return type: string

Variable Details

pushScope

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

To use, import via @fluidframework/odsp-doclib-utils/legacy.

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

Signature

pushScope = "offline_access https://pushchannel.1drv.ms/PushChannel.ReadWrite.All"