Interface IGetUrlOptions

Options for getUrl

interface IGetUrlOptions {
    mode?: string;
    toShare?: boolean;
    treePath?: string;
    workspace?: string;
}

Properties

mode? toShare? treePath? workspace?

Properties

Optionalmode

mode?: string

The optional mode as a string 'single-document' or 'multiple-document'. If the mode argument is missing, it will be provided from the PageConfig.

OptionaltoShare

toShare?: boolean

Whether the url is meant to be shared or not; default false.

OptionaltreePath

treePath?: string

The optional tree path as as string. If treePath is not provided it will be provided from the PageConfig. If an empty string, the resulting path will not contain a tree portion.

Optionalworkspace

workspace?: string

The optional workspace as a string. If this argument is missing, the value will be pulled from PageConfig. To use the default workspace (no /workspaces/ URL segment will be included) pass the string PageConfig.defaultWorkspace.

Settings

Member Visibility

On This Page

Properties