Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UrlResolver

A default resolver that uses a given reference path and a contents manager.

Hierarchy

  • UrlResolver

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _contents

_contents: any

Private _path

_path: any

Private _session

_session: any

Accessors

path

  • get path(): string
  • set path(value: string): void

  • The path of the object, from which local urls can be derived.

    Returns string

  • The path of the object, from which local urls can be derived.

    Parameters

    • value: string

    Returns void

Methods

getDownloadUrl

  • getDownloadUrl(urlPath: string): Promise<string>

  • Get the download url of a given absolute url path.

    Notes

    The returned URL may include a query parameter.

    Parameters

    • urlPath: string

    Returns Promise<string>

isLocal

  • isLocal(url: string): boolean

  • Whether the URL should be handled by the resolver or not.

    Notes

    This is similar to the isLocal check in URLExt, but it also checks whether the path points to any of the IDrives that may be registered with the contents manager.

    Parameters

    • url: string

    Returns boolean

isMalformed

  • isMalformed(url: string): boolean

  • Whether the URL can be decoded using decodeURI.

    Parameters

    • url: string

    Returns boolean

resolveUrl

  • resolveUrl(url: string): Promise<string>

  • Resolve a relative url to an absolute url path.

    Parameters

    • url: string

    Returns Promise<string>

Generated using TypeDoc