Interface IInteractiveComponentInstance
interface IInteractiveComponentInstance
Extends IComponentInstance2
IInteractiveComponentInstance interface contains methods to configure and manage an interactive
component instance.
This interface is only available for interactive components.
Methods
requestBack()
void requestBack()
Requests dismissal of the component instance, triggering a back transition.
Attempts to initiate the background sequence for the component and may ultimately invoke the
onBackground callback.
For the invocation to be successful this method should be called from within the
application process this component instance is a part of.
Throws
InvalidOperationError— if called from outside of the application process this instance is a part of. Note: Duplicate requests are handled gracefully as long as the above failure conditions are not met.
makeInstanceConfigBuilder()
Makes a newIInteractiveComponentConfigurationBuilder*makeInstanceConfigBuilder()
IInteractiveComponentConfigurationBuilder, which can be used to construct
[IInteractiveComponentConfiguration] for the given lifespan and timeout values.
Returns
IInteractiveComponentConfigurationBuilder*
An instance of IInteractiveComponentConfigurationBuilder.
configure()
Configures the component instance with the provided lifespan and timeout. This method can be called multiple times to update the configuration across the lifetime of the component instance. The latest configuration processed by the framework is honored. If never called, the component instance will use the default configuration provided by the application manifest.voidconfigure(IInteractiveComponentConfiguration*config)
Parameters
config
IInteractiveComponentConfiguration* — Required
An object containing the lifespan and timeout of the component.
Throws
NotSupportedError— if the component is not an interactive component.InvalidOperationError— if called from outside of the application process this instance is a part of.
