nugu-agent/com.skt.nugu.sdk.agent.display/DisplayAgent

DisplayAgent

class DisplayAgent( playSynchronizer: PlaySynchronizerInterface, elementSelectedEventHandler: ElementSelectedEventHandler, triggerChildEventSender: TriggerChildEventSender, sessionManager: SessionManagerInterface, interLayerDisplayPolicyManager: InterLayerDisplayPolicyManager, contextStateProviderRegistry: ContextStateProviderRegistry, enableDisplayLifeCycleManagement: Boolean, defaultDuration: Long) : CapabilityAgent, DisplayAgentInterface, SupportedInterfaceContextProvider, ControlFocusDirectiveHandler.Controller, ControlScrollDirectiveHandler.Controller, CloseDirectiveHandler.Controller, UpdateDirectiveHandler.Controller, RenderDirectiveHandler.Controller, RedirectTriggerChildDirectiveHandler.Controller, PlayStackManagerInterface.PlayContextProvider

Constructors

DisplayAgent

fun DisplayAgent( playSynchronizer: PlaySynchronizerInterface, elementSelectedEventHandler: ElementSelectedEventHandler, triggerChildEventSender: TriggerChildEventSender, sessionManager: SessionManagerInterface, interLayerDisplayPolicyManager: InterLayerDisplayPolicyManager, contextStateProviderRegistry: ContextStateProviderRegistry, enableDisplayLifeCycleManagement: Boolean, defaultDuration: Long)

Types

Companion

object Companion

DisplayContext

data class DisplayContext( val playServiceId: String?, val token: String?, val focusedItemToken: String?, val visibleTokenList: List<String>?)

TemplatePayload

data class TemplatePayload( val playServiceId: String?, val token: String?, val duration: String?, val contextLayer: DisplayAgentInterface.ContextLayer?, val playStackControl: PlayStackControl?, val historyControl: HistoryControl?)

Functions

addListener

open override fun addListener(listener: DisplayAgentInterface.Listener)

cancelRender

open override fun cancelRender(messageId: String)

open override fun close(playServiceId: String, listener: CloseDirectiveHandler.Controller.OnCloseListener)

controlFocus

open override fun controlFocus(playServiceId: String, direction: Direction): Boolean

controlScroll

open override fun controlScroll(playServiceId: String, direction: Direction): Boolean

displayCardCleared

open override fun displayCardCleared(templateId: String)

Notifies the display that has been cleared.

displayCardRendered

open override fun displayCardRendered(templateId: String, controller: DisplayAgentInterface.Controller?)

Notifies the display that has been rendered.

displayCardRenderFailed

open override fun displayCardRenderFailed(templateId: String)

Notifies the display that has been render failed.

getPlayContext

open override fun getPlayContext(): PlayStackManagerInterface.PlayContext?

notifyUserInteraction

open override fun notifyUserInteraction(templateId: String)

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

preRender

open override fun preRender(info: RenderDirectiveHandler.RenderDirectiveInfo)

provideState

open override fun provideState( contextSetter: ContextSetterInterface, namespaceAndName: NamespaceAndName, contextType: ContextType, stateRequestToken: Int)

redirectTriggerChild

open override fun redirectTriggerChild( header: Header, payload: RedirectTriggerChildDirectiveHandler.Payload, result: RedirectTriggerChildDirectiveHandler.Controller.OnResultListener)

removeListener

open override fun removeListener(listener: DisplayAgentInterface.Listener)

render

open override fun render(messageId: String, listener: RenderDirectiveHandler.Controller.OnResultListener)

setElementSelected

open override fun setElementSelected( templateId: String, token: String, postback: String?, callback: DisplayInterface.OnElementSelectedCallback?): String

Each element has it's own token.

setRenderer

open override fun setRenderer(renderer: DisplayAgentInterface.Renderer?)

Set a renderer to interact with the display agent.

triggerChild

open override fun triggerChild( templateId: String, playServiceId: String, data: JsonObject, callback: DisplayAgentInterface.OnTriggerChildCallback?)

update

open override fun update( header: Header, token: String, payload: String, listener: UpdateDirectiveHandler.Controller.OnUpdateListener)

Properties

namespaceAndName

open override val namespaceAndName: NamespaceAndName