In package com.eden.orchid.api.render

class com.eden.orchid.api.render.RenderService

Methods

public open getRenderedTemplate(com.eden.orchid.api.theme.pages.OrchidPage):

Render the given page with the default template determined by the page, returning an InputStream representing the final contents. The layout chosen for the page is determined by TemplateResolutionStrategy.

Parameters:
public open renderBinary(com.eden.orchid.api.theme.pages.OrchidPage): Boolean

Render the content of a page directly, as a binary stream, producing a side-effect as the intended final output. No further processing is performed on the file contents, so as to preserve the binary format.

Parameters:
public open getRenderedBinary(com.eden.orchid.api.theme.pages.OrchidPage):

Render the content of a page directly, as a binary stream, returning an InputStream representing the final contents. No further processing is performed on the file contents, so as to preserve the binary format.

Parameters:
public open includeDrafts(): Boolean

Whether to exclude drafts, which is the default behavior, or whether to include them.

Parameters:
  • No parameters
public open getRenderedRaw(com.eden.orchid.api.theme.pages.OrchidPage):

Render the content of a page directly, without any template, returning an InputStream representing the final contents. The contents may still be preprocessed, and is useful for rendering text assets like CSS or JS.

Parameters:
public open getRenderedString(com.eden.orchid.api.theme.pages.OrchidPage, kotlin.String, kotlin.String):

Render the given page using a literal String as a template, returning an InputStream representing the final contents. More useful for testing, as templates should be preferred for the ability to be overridden.

Parameters:
public open renderString(com.eden.orchid.api.theme.pages.OrchidPage, kotlin.String, kotlin.String): Boolean

Render the given page using a literal String as a template, producing a side-effect as the intended final output. More useful for testing, as templates should be preferred for the ability to be overridden.

Parameters:
public open getRendered(com.eden.orchid.api.theme.pages.OrchidPage, com.eden.orchid.api.render.RenderService.RenderMode):

Dynamically use a RenderMode enum to determine which rendering operation to perform.

Parameters:
public open getRendered(com.eden.orchid.api.theme.pages.OrchidPage, kotlin.String):

Dynamically convert a String to a RenderMode to determine which rendering operation to perform.

Parameters:
public open renderRaw(com.eden.orchid.api.theme.pages.OrchidPage): Boolean

Render the content of a page directly, without any template, producing a side-effect as the intended final output. The contents may still be preprocessed, and is useful for rendering text assets like CSS or JS.

Parameters:
public open getKey(): String

Parameters:
  • No parameters
public open render(com.eden.orchid.api.theme.pages.OrchidPage, com.eden.orchid.api.render.RenderService.RenderMode): Boolean

Dynamically use a RenderMode enum to determine which rendering operation to perform.

Parameters:
public open render(com.eden.orchid.api.theme.pages.OrchidPage, kotlin.String): Boolean

Dynamically convert a String to a RenderMode to determine which rendering operation to perform.

Parameters:
public open renderTemplate(com.eden.orchid.api.theme.pages.OrchidPage): Boolean

Render the given page with the default template determined by the page, producing a side-effect as the intended final output. The layout chosen for the page is determined by TemplateResolutionStrategy.

Parameters: