OdspDriverUrlResolver Class
Resolver to resolve urls like the ones created by createOdspUrl which is driver inner url format. Ex: ${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/odsp-driver/legacy.
For more information about our API support guarantees, see here.
Signature
export declare class OdspDriverUrlResolver implements IUrlResolver
Implements: IUrlResolver
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)() | Beta | Constructs a new instance of the OdspDriverUrlResolver class |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getAbsoluteUrl(resolvedUrl, relativeUrl, packageInfoSource) | Beta | Promise<string> | Requests a driver + data store storage URL. |
| resolve(request) | Beta | Promise<IOdspResolvedUrl> |
Constructor Details
(constructor)
Constructs a new instance of the OdspDriverUrlResolver class
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
constructor();
Method Details
getAbsoluteUrl
Requests a driver + data store storage URL.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| resolvedUrl | IResolvedUrl | The driver resolved URL. | |
| relativeUrl | string | The relative data store path URL. For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath will be extracted from the resolved url if present. | |
| packageInfoSource | optional | IContainerPackageInfo | optional, represents container package information to be included in url. |
Returns
Return type: Promise<string>
resolve
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
resolve(request: IRequest): Promise<IOdspResolvedUrl>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| request | IRequest |
Returns
Return type: Promise<IOdspResolvedUrl>