apple.intents.protocol

Interface INSearchCallHistoryIntentHandling

All Known Subinterfaces:

INCallsDomainHandling

public interface INSearchCallHistoryIntentHandling

Protocol to declare support for handling an INSearchCallHistoryIntent. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INSearchCallHistoryIntentHandling.Block_confirmSearchCallHistoryCompletion
static interface	INSearchCallHistoryIntentHandling.Block_handleSearchCallHistoryCompletion
static interface	INSearchCallHistoryIntentHandling.Block_resolveCallTypeForSearchCallHistoryWithCompletion
static interface	INSearchCallHistoryIntentHandling.Block_resolveCallTypesForSearchCallHistoryWithCompletion
static interface	INSearchCallHistoryIntentHandling.Block_resolveDateCreatedForSearchCallHistoryWithCompletion
static interface	INSearchCallHistoryIntentHandling.Block_resolveRecipientForSearchCallHistoryWithCompletion
static interface	INSearchCallHistoryIntentHandling.Block_resolveUnseenForSearchCallHistoryWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSearchCallHistoryCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_confirmSearchCallHistoryCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchCallHistoryCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_handleSearchCallHistoryCompletion completion) Handling method - Execute the task represented by the INSearchCallHistoryIntent that's passed in
default void	resolveCallTypeForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_resolveCallTypeForSearchCallHistoryWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveCallTypesForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_resolveCallTypesForSearchCallHistoryWithCompletion completion)
default void	resolveDateCreatedForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_resolveDateCreatedForSearchCallHistoryWithCompletion completion)
default void	resolveRecipientForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_resolveRecipientForSearchCallHistoryWithCompletion completion)
default void	resolveUnseenForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent, INSearchCallHistoryIntentHandling.Block_resolveUnseenForSearchCallHistoryWithCompletion completion)

Method Detail

confirmSearchCallHistoryCompletion

default void confirmSearchCallHistoryCompletion(INSearchCallHistoryIntent intent,
                                                INSearchCallHistoryIntentHandling.Block_confirmSearchCallHistoryCompletion 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 INSearchCallHistoryIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchCallHistoryIntentResponse

handleSearchCallHistoryCompletion

void handleSearchCallHistoryCompletion(INSearchCallHistoryIntent intent,
                                       INSearchCallHistoryIntentHandling.Block_handleSearchCallHistoryCompletion completion)

Handling method - Execute the task represented by the INSearchCallHistoryIntent 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 INSearchCallHistoryIntentResponse containing the details of the result of having executed the intent

See Also:

INSearchCallHistoryIntentResponse

resolveCallTypeForSearchCallHistoryWithCompletion

default void resolveCallTypeForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent,
                                                               INSearchCallHistoryIntentHandling.Block_resolveCallTypeForSearchCallHistoryWithCompletion 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

resolveDateCreatedForSearchCallHistoryWithCompletion

default void resolveDateCreatedForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent,
                                                                  INSearchCallHistoryIntentHandling.Block_resolveDateCreatedForSearchCallHistoryWithCompletion completion)

resolveRecipientForSearchCallHistoryWithCompletion

default void resolveRecipientForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent,
                                                                INSearchCallHistoryIntentHandling.Block_resolveRecipientForSearchCallHistoryWithCompletion completion)

resolveCallTypesForSearchCallHistoryWithCompletion

default void resolveCallTypesForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent,
                                                                INSearchCallHistoryIntentHandling.Block_resolveCallTypesForSearchCallHistoryWithCompletion completion)

resolveUnseenForSearchCallHistoryWithCompletion

default void resolveUnseenForSearchCallHistoryWithCompletion(INSearchCallHistoryIntent intent,
                                                             INSearchCallHistoryIntentHandling.Block_resolveUnseenForSearchCallHistoryWithCompletion completion)