Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "index"

Index

Type aliases

OC16to17

OC16to17: OC | OC

Variables

OC

Functions

Const generateFilePath

  • generateFilePath(app: string, type: string, file: string): string
  • Get the absolute url for a file in an app

    Parameters

    • app: string

      the id of the app

    • type: string

      the type of the file to link to (e.g. css,img,ajax.template)

    • file: string

      the filename

    Returns string

    Absolute URL for a file in an app

Const generateOcsUrl

  • generateOcsUrl(service: string, version: Number): string
  • Get the base path for the given OCS API service

    Parameters

    • service: string

      name

    • version: Number

      OCS API version

    Returns string

    OCS API base path

Const generateRemoteUrl

  • generateRemoteUrl(service: string): string
  • Parameters

    • service: string

      id

    Returns string

    the url

Const generateUrl

  • generateUrl(url: string, params?: undefined | object, options?: UrlOptions): string
  • Generate the absolute url for the given relative url, which can contain parameters

    Parameters will be URL encoded automatically

    Parameters

    • url: string
    • Optional params: undefined | object
    • Optional options: UrlOptions

    Returns string

    Absolute URL for the given relative URL

Const getRootUrl

  • getRootUrl(): string
  • Return the web root path where this Nextcloud instance is accessible, with a leading slash. For example "/nextcloud".

    Returns string

    web root path

Const imagePath

  • imagePath(app: string, file: string): string
  • Get the absolute path to an image file if no extension is given for the image, it will automatically decide between .png and .svg based on what the browser supports

    Parameters

    • app: string

      the app id to which the image belongs

    • file: string

      the name of the image file

    Returns string

Const linkTo

  • linkTo(app: string, file: string): string
  • Get an absolute url to a file in an app

    Parameters

    • app: string

      the id of the app the file belongs to

    • file: string

      the file path relative to the app folder

    Returns string

    Absolute URL to a file

Const linkToRemoteBase

  • linkToRemoteBase(service: string): string
  • Creates a relative url for remote use

    Parameters

    • service: string

      id

    Returns string

    the url

Generated using TypeDoc