In package com.eden.orchid.api.resources.resource

class com.eden.orchid.api.resources.resource.ExternalResource

An ExternalResource acts either as a placeholder for URL reference, or can be a full resource when set to download. When an ExternalResource is set to download, the file at the original URL will be downloaded and cached when its contents are requested, so that external pages or assets can be requested at build-time from a CDN or other external location, but served locally so your output site has no dependency on that external service. By default, ExternalResources are set to not download, and instead just point to the desired resource.

Constructors

public <init>(com.eden.orchid.api.theme.pages.OrchidReference)

Parameters:

Methods

public final free(): Unit

Parameters:
  • No parameters
public final setDownload(kotlin.Boolean): Unit

Parameters:
  • download: Boolean
public final getContent(): String

Parameters:
  • No parameters
public final shouldRender(): Boolean

Parameters:
  • No parameters
public final getRawContent(): String

Parameters:
  • No parameters
public final getContentStream():

Parameters:
  • No parameters
public final getEmbeddedData(): JSONElement

Parameters:
  • No parameters
public final setContent(kotlin.String): Unit

Parameters:
  • content: String
public final queryEmbeddedData(kotlin.String): JSONElement

Parameters:
  • pointer: String
public final setRawContent(kotlin.String): Unit

Parameters:
  • rawContent: String
public final shouldPrecompile(): Boolean

Parameters:
  • No parameters