PlatformEventSources


object PlatformEventSources


Dynamic types for platform events

Summary

Nested types

Dynamic layout update status value.

Data sources keys for platform event.

Constants

const Int

There are no pending layout updates.

const Int

A new layout has been requested, but there was an error.

const Int

A new layout has been requested.

Public functions

DynamicBuilders.DynamicBool
@RequiresSchemaVersion(major = 1, minor = 500)
isLayoutVisible()

Returns a DynamicBool which receives the current visibility status from platform.

PlatformEventSources.DynamicLayoutUpdateStatus
@RequiresSchemaVersion(major = 1, minor = 600)
layoutUpdateStatus()

Returns a DynamicLayoutUpdateStatus representing the current status of the layout update.

Constants

LAYOUT_UPDATE_IDLE

Added in 1.4.0-alpha01
const val LAYOUT_UPDATE_IDLE = 0: Int

There are no pending layout updates.

LAYOUT_UPDATE_IDLE_ERROR

Added in 1.4.0-alpha01
const val LAYOUT_UPDATE_IDLE_ERROR = 2: Int

A new layout has been requested, but there was an error. The system will retry the update.

LAYOUT_UPDATE_WAITING

Added in 1.4.0-alpha01
const val LAYOUT_UPDATE_WAITING = 1: Int

A new layout has been requested.

Public functions

isLayoutVisible

Added in 1.3.0
@RequiresSchemaVersion(major = 1, minor = 500)
fun isLayoutVisible(): DynamicBuilders.DynamicBool

Returns a DynamicBool which receives the current visibility status from platform.

The visibility status value is true when layout is visible, and false when invisible.

layoutUpdateStatus

Added in 1.4.0-alpha01
@RequiresSchemaVersion(major = 1, minor = 600)
fun layoutUpdateStatus(): PlatformEventSources.DynamicLayoutUpdateStatus

Returns a DynamicLayoutUpdateStatus representing the current status of the layout update.

The platform requests a new layout when explicitly requested by the tile provider, or when the current layout becomes invalidated.

The layout update status can be one of the following: