IRouterliciousResolvedUrl Interface

Routerlicious extends the resolved url with additional properties to control Routerlicious-specific behaviors.

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

To use, import via @fluidframework/routerlicious-driver/legacy.

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

Signature

export interface IRouterliciousResolvedUrl extends IResolvedUrl

Extends: IResolvedUrl

Property	Alerts	Modifiers	Default Value	Type	Description
createAsEphemeral	`Alpha`	`optional`	If left undefined, treated as `false`	boolean	Controls whether a newly created container will be ephemeral, which means the service will not retain it after the collaboration session ends. Only affects createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) requests.
routerliciousResolvedUrl	`Alpha`			true	A flag to facilitate type narrowing from IResolvedUrl to IRouterliciousResolvedUrl.

Controls whether a newly created container will be ephemeral, which means the service will not retain it after the collaboration session ends. Only affects createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) requests.

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

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

createAsEphemeral?: boolean;

Type: boolean

A flag to facilitate type narrowing from IResolvedUrl to IRouterliciousResolvedUrl.

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

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

routerliciousResolvedUrl: true;

Type: true