Skip to main content

@fluidframework/odsp-doclib-utils Package

Interfaces

InterfaceAlertsDescription
IOdspAuthRequestInfoLegacy

Functions

FunctionAlertsReturn TypeDescription
getDriveId(server, account, library, authRequestInfo)LegacyPromise<string>
getOdspScope(server)Legacystring

Variables

VariableAlertsModifiersTypeDescription
pushScopeLegacyreadonly

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

ParameterTypeDescription
serverstring
accountstring
librarystring | undefined
authRequestInfoIOdspAuthRequestInfo

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

ParameterTypeDescription
serverstring

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"