LayoutElementBuilders.ExtensionLayoutElement

@RequiresSchemaVersion(major = 1, minor = 200)
@ExperimentalProtoLayoutExtensionApi
class LayoutElementBuilders.ExtensionLayoutElement : LayoutElementBuilders.LayoutElement

A layout element which can be defined by a renderer extension. The payload in this message will be passed verbatim to any registered renderer extension in the renderer. It is then expected that the extension can parse this message, and emit the relevant element.

If a renderer extension is not installed, this resource will not render any element, although the specified space will still be occupied. If the payload cannot be parsed by the renderer extension, then still nothing should be rendered, although this behaviour is defined by the renderer extension.

Summary

Nested types

Builder for ExtensionLayoutElement.

Public functions
String

Gets the ID of the renderer extension that should be used for rendering this layout element.
DimensionBuilders.ExtensionDimension?

Gets the height of this element.
ByteArray<Byte>

Gets the content of the renderer extension element.
DimensionBuilders.ExtensionDimension?

Gets the width of this element.
String

Public functions

getExtensionId

Added in 1.0.0
fun getExtensionId(): String

Gets the ID of the renderer extension that should be used for rendering this layout element.

getHeight

Added in 1.0.0
fun getHeight(): DimensionBuilders.ExtensionDimension?

Gets the height of this element.

getPayload

Added in 1.0.0
fun getPayload(): ByteArray<Byte>

Gets the content of the renderer extension element. This can be any data; it is expected that the renderer extension knows how to parse this field.

getWidth

Added in 1.0.0
fun getWidth(): DimensionBuilders.ExtensionDimension?

Gets the width of this element.

toString

fun toString(): String