Package apple.intents.protocol

Interface INGetVisualCodeIntentHandling

  • All Known Subinterfaces:
    INVisualCodeDomainHandling
    public interface INGetVisualCodeIntentHandling
    Protocol to declare support for handling an INGetVisualCodeIntent. By implementing this protocol, a class can provide logic for resolving, confirming and handling the intent. The minimum requirement for an implementing class is that it should be able to handle the intent. The resolution and confirmation methods are optional. The handling method is always called last, after resolving and confirming the intent.

    • Method Detail

      • confirmGetVisualCodeCompletion

        default void confirmGetVisualCodeCompletion​(INGetVisualCodeIntent intent,
                                            INGetVisualCodeIntentHandling.Block_confirmGetVisualCodeCompletion completion)
        Confirmation method - Validate that this intent is ready for the next step (i.e. handling) Called prior to asking the app to handle the intent. The app should return a response object that contains additional information about the intent, which may be relevant for the system to show the user prior to handling. If unimplemented, the system will assume the intent is valid following resolution, and will assume there is no additional information relevant to this intent.
        Parameters:
        intent - The input intent
        completion - The response block contains an INGetVisualCodeIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.
        See Also:
        INGetVisualCodeIntentResponse

      • handleGetVisualCodeCompletion

        void handleGetVisualCodeCompletion​(INGetVisualCodeIntent intent,
                                   INGetVisualCodeIntentHandling.Block_handleGetVisualCodeCompletion completion)
        Handling method - Execute the task represented by the INGetVisualCodeIntent that's passed in Called to actually execute the intent. The app must return a response for this intent.
        Parameters:
        intent - The input intent
        completion - The response handling block takes a INGetVisualCodeIntentResponse containing the details of the result of having executed the intent
        See Also:
        INGetVisualCodeIntentResponse

      • resolveVisualCodeTypeForGetVisualCodeWithCompletion

        default void resolveVisualCodeTypeForGetVisualCodeWithCompletion​(INGetVisualCodeIntent intent,
                                                                 INGetVisualCodeIntentHandling.Block_resolveVisualCodeTypeForGetVisualCodeWithCompletion completion)
        Resolution methods - Determine if this intent is ready for the next step (confirmation) Called to make sure the app extension is capable of handling this intent in its current form. This method is for validating if the intent needs any further fleshing out.
        Parameters:
        intent - The input intent
        completion - The response block contains an INIntentResolutionResult for the parameter being resolved
        See Also:
        INIntentResolutionResult