Package-level declarations

Types

Link copied to clipboard
class Context : GeneratedMessage, ContextOrBuilder
Defines the notion of a *Render Context* for server-side pages in Gust. This protocol message is filled out with data
as configured by the developer (from `application.yml` and the active controller, as applicable) and provided as an
injected value to all server-side render operations.

When preparing context in Gust, adding a static script or stylesheet is done through `Context`. Setting page metadata
like the title, keywords, and manifest - also all done through `Context`. This of course has the added benefit of
being completely serializable, repeatable, and so on (i.e. all the benefits Protobuf brings).

Major context modules include:
- *Metadata*: Page-level metadata.
- *OpenGraph*: Properties for OG tags.
- *Twitter*: Properties for Twitter cards.
- *AppManifest*: Information to link or derive a web application manifest.
- *Styles*: Stylesheets and inline head-injected styles ("lifted styles").
- *Scripts*: Scripts to include, and inline head-injected logic ("lifted JS").
Protobuf type elide.page.Context
Link copied to clipboard
object ContextKt

Protobuf type elide.page.Context

Link copied to clipboard
interface ContextOrBuilder : MessageOrBuilder
Link copied to clipboard
enum Format : ProtocolMessageEnum
Enumerates semantic metadata formats that are supported for rendering into the page.
Protobuf enum elide.page.Format
Link copied to clipboard
enum Kind : ProtocolMessageEnum
Enumerates known semantic types, which are further mapped to their implementation types in each
semantic expression framework by implementing code.
Protobuf enum elide.page.Kind
Link copied to clipboard
class MediaAsset : GeneratedMessage, MediaAssetOrBuilder
Defines the structure of attached content media, which is intended for emission in a given web page
via some sort of render process, depending on the context in which this media is used.
Protobuf type elide.page.MediaAsset
Link copied to clipboard

Protobuf type elide.page.MediaAsset

Link copied to clipboard
interface MediaAssetOrBuilder : MessageOrBuilder
Link copied to clipboard
enum MediaType : ProtocolMessageEnum
Defines broad types of media that may be expressed.
Protobuf enum elide.page.MediaType
Link copied to clipboard
Defines the structure of top-level metadata with regard to semantic content, attached to a given
web page for emission in meta tags in various formats.
Protobuf type elide.page.SemanticMetadata
Link copied to clipboard

Protobuf type elide.page.SemanticMetadata

Link copied to clipboard
interface SemanticMetadataOrBuilder : MessageOrBuilder
Link copied to clipboard
enum VideoProvider : ProtocolMessageEnum
Enumerates known or supported video asset providers.
Protobuf enum elide.page.VideoProvider
Link copied to clipboard
enum VideoResolution : ProtocolMessageEnum
Describes resolutions at which video assets may be made available.
Protobuf enum elide.page.VideoResolution
Link copied to clipboard
Link copied to clipboard
class WebMedia
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
val ContextOrBuilder.cdnPrefixOrNull: TrustedResourceUrlProto?
Link copied to clipboard
Link copied to clipboard
val Context.PageLinkOrBuilder.hrefOrNull: TrustedResourceUrlProto?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val Context.AppManifest.IconOrBuilder.srcOrNull: TrustedResourceUrlProto?
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@JvmName(name = "-initializecontext")
inline fun context(block: ContextKt.Dsl.() -> Unit): Context
Link copied to clipboard
inline fun Context.copy(block: ContextKt.Dsl.() -> Unit): Context
inline fun MediaAsset.copy(block: MediaAssetKt.Dsl.() -> Unit): MediaAsset
Link copied to clipboard
@JvmName(name = "-initializemediaAsset")
inline fun mediaAsset(block: MediaAssetKt.Dsl.() -> Unit): MediaAsset
Link copied to clipboard
@JvmName(name = "-initializesemanticMetadata")
inline fun semanticMetadata(block: SemanticMetadataKt.Dsl.() -> Unit): SemanticMetadata