DisplayAgentInterface

The public interface for DisplayAgent

Types

Link copied to clipboard
enum ContextLayer : Enum<DisplayAgentInterface.ContextLayer>
Link copied to clipboard
interface Controller
Link copied to clipboard
interface Listener
Link copied to clipboard
interface OnTriggerChildCallback : EventCallback<DisplayInterface.ErrorType>
Link copied to clipboard
interface Renderer

The renderer of display agent. When receive an directive for display, the agent will request the renderer to render it.

Functions

Link copied to clipboard
abstract fun addListener(listener: DisplayAgentInterface.Listener)
Link copied to clipboard
abstract fun displayCardCleared(templateId: String)

Notifies the display that has been cleared.

Link copied to clipboard
abstract fun displayCardRendered(templateId: String, controller: DisplayAgentInterface.Controller?)

Notifies the display that has been rendered.

Link copied to clipboard
abstract fun displayCardRenderFailed(templateId: String)

Notifies the display that has been render failed.

Link copied to clipboard
abstract fun notifyUserInteraction(templateId: String)

This should be called when occur interaction(input event such as touch, drag, etc...) for display

Link copied to clipboard
abstract fun removeListener(listener: DisplayAgentInterface.Listener)
Link copied to clipboard
abstract fun setElementSelected(    templateId: String,     token: String,     postback: String? = null,     callback: DisplayInterface.OnElementSelectedCallback? = null): String

Each element has it's own token.

Link copied to clipboard
abstract fun setRenderer(renderer: DisplayAgentInterface.Renderer?)

Set a renderer to interact with the display agent.

Link copied to clipboard
abstract fun triggerChild(    templateId: String,     playServiceId: String,     data: JsonObject,     callback: DisplayAgentInterface.OnTriggerChildCallback?)

Inheritors

Link copied to clipboard