IInteractiveComponentConfigurationBuilder

​

Interface IInteractiveComponentConfigurationBuilder

interface IInteractiveComponentConfigurationBuilder

Extends com.amazon.apmf.IStandard IInteractiveComponentConfigurationBuilder interface contains methods to build a [IInteractiveComponentConfiguration] using the provided lifespan and timeout values. Allows setting lifespan and timeout values. If no lifespan is provided, the previously set lifespan is retained. Likewise if no timeout is provided, the previously set timeout is retained.

​

Methods

​

transientLifespan()

IInteractiveComponentConfigurationBuilder* transientLifespan()

Sets a transient lifespan for an interactive component instance. During backstack walks the next acceptable instance to transition to is one with a SHORT lifespan or longer.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

shortLifespan()

IInteractiveComponentConfigurationBuilder* shortLifespan()

Sets a short lifespan for an interactive component instance. During backstack walks the next acceptable instance to transition to is one with a LONG lifespan or longer.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

longLifespan()

IInteractiveComponentConfigurationBuilder* longLifespan()

Sets a long lifespan for an interactive component instance. During backstack walks the next acceptable instance to transition to is one with a LONG lifespan or longer.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

permanentLifespan()

IInteractiveComponentConfigurationBuilder* permanentLifespan()

Sets a permanent lifespan for an interactive component instance. During backstack walks the next acceptable instance to transition to is another one with a PERMANENT lifespan. Note: Timeout is ignored if a permanent lifespan is set.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

timeout()

IInteractiveComponentConfigurationBuilder* timeout(com.amazon.apmf.MonotonicDuration timeout)

Sets the timeout for an interactive component instance after which the instance must be backgrounded automatically. Note: This timeout is ignored if lifespan is PERMANENT.

​

Parameters

timeout

com.amazon.apmf.MonotonicDuration — Required A timeout value after which the component instance must be dismissed from the screen.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

disableTimeout()

IInteractiveComponentConfigurationBuilder* disableTimeout()

Disables the automatic backgrounding of component behavior for a component instance. When this happens the backstack walk behavior continues to be governed by the lifespan configuration.

​

Returns

IInteractiveComponentConfigurationBuilder* [IInteractiveComponentConfigurationBuilder] object used to build the config.

---

​

build()

IInteractiveComponentConfiguration* build()

Creates an [IInteractiveComponentConfiguration] object for the provided lifespan and timeout config.

​

Returns

IInteractiveComponentConfiguration* [IInteractiveComponentConfiguration] object which can be provided to the [IInteractiveComponentInstance#configure] method for the component’s timeout manager related config, if lifespan and timeout are valid.

​

Throws

• InvalidArgumentError — if lifespan and/or timeout are invalid.

---