apple.intentsui.protocol

Interface INUIHostedViewControlling

public interface INUIHostedViewControlling

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INUIHostedViewControlling.Block_configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion
static interface	INUIHostedViewControlling.Block_configureWithInteractionContextCompletion

Method Summary

Modifier and Type	Method and Description
default void	configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion(NSSet<? extends INParameter> parameters, INInteraction interaction, long interactiveBehavior, long context, INUIHostedViewControlling.Block_configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion completion) Perform configuration of UI based on the provided INInteraction and INParameter objects.
default void	configureWithInteractionContextCompletion(INInteraction interaction, long context, INUIHostedViewControlling.Block_configureWithInteractionContextCompletion completion) Perform configuration of UI based on the provided INInteraction object.

Method Detail

configureWithInteractionContextCompletion

default void configureWithInteractionContextCompletion(INInteraction interaction,
                                                       long context,
                                                       INUIHostedViewControlling.Block_configureWithInteractionContextCompletion completion)

Perform configuration of UI based on the provided INInteraction object.

When configuration is complete for the given interaction, the hosted view controller should call the completion block with its view's desired size. This size will be constrained between hostedViewMinimumAllowedSize and hostedViewMaximumAllowedSize of the extension context.

Parameters:

interaction - The input interaction

context - The hosting context for this interaction. The hosted view will be displayed alongside this context -- for instance, a Siri result snippet, or a place card within Maps.

completion - The response handling block takes one parameter corresponding the optional desiredSize property of the INUIHostedViewControlling protocol

See Also:

INInteraction

configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion

default void configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion(NSSet<? extends INParameter> parameters,
                                                                                         INInteraction interaction,
                                                                                         long interactiveBehavior,
                                                                                         long context,
                                                                                         INUIHostedViewControlling.Block_configureViewForParametersOfInteractionInteractiveBehaviorContextCompletion completion)

Perform configuration of UI based on the provided INInteraction and INParameter objects.

When configuration is complete for the given parameters and interaction, the hosted view controller should call the completion block with whether it was successful, the parameters it configured itself with, and its view's desired size. The size of the view will ultimately be constrained between hostedViewMinimumAllowedSize and hostedViewMaximumAllowedSize of the extension context.

Parameters:

parameters - The parameters of the interaction for which to configure the view

interaction - The input interaction

interactiveBehavior - The behavior that will be driven by user interaction of this view

context - The hosting context for this interaction. The hosted view will be displayed within/alongside this context -- for instance, a Siri result snippet, or a place card within Maps.

completion - The response handling block takes the following: A) a success boolean, which tells the hosted view context if this view was successfully configured, B) the set of parameters that this view was successfully configured for, and C) a desiredSize for this view to be sized at within the hosted view context.

See Also:

INParameter, INInteraction