apple.intents.protocol

Interface INSearchForPhotosIntentHandling

All Known Subinterfaces:

INPhotosDomainHandling

public interface INSearchForPhotosIntentHandling

Protocol to declare support for handling an INSearchForPhotosIntent. 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	INSearchForPhotosIntentHandling.Block_confirmSearchForPhotosCompletion
static interface	INSearchForPhotosIntentHandling.Block_handleSearchForPhotosCompletion
static interface	INSearchForPhotosIntentHandling.Block_resolveAlbumNameForSearchForPhotosWithCompletion
static interface	INSearchForPhotosIntentHandling.Block_resolveDateCreatedForSearchForPhotosWithCompletion
static interface	INSearchForPhotosIntentHandling.Block_resolveLocationCreatedForSearchForPhotosWithCompletion
static interface	INSearchForPhotosIntentHandling.Block_resolvePeopleInPhotoForSearchForPhotosWithCompletion
static interface	INSearchForPhotosIntentHandling.Block_resolveSearchTermsForSearchForPhotosWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSearchForPhotosCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_confirmSearchForPhotosCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchForPhotosCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_handleSearchForPhotosCompletion completion) Handling method - Execute the task represented by the INSearchForPhotosIntent that's passed in
default void	resolveAlbumNameForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_resolveAlbumNameForSearchForPhotosWithCompletion completion)
default void	resolveDateCreatedForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_resolveDateCreatedForSearchForPhotosWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveLocationCreatedForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_resolveLocationCreatedForSearchForPhotosWithCompletion completion)
default void	resolvePeopleInPhotoForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_resolvePeopleInPhotoForSearchForPhotosWithCompletion completion)
default void	resolveSearchTermsForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent, INSearchForPhotosIntentHandling.Block_resolveSearchTermsForSearchForPhotosWithCompletion completion)

Method Detail

confirmSearchForPhotosCompletion

default void confirmSearchForPhotosCompletion(INSearchForPhotosIntent intent,
                                              INSearchForPhotosIntentHandling.Block_confirmSearchForPhotosCompletion 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 INSearchForPhotosIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchForPhotosIntentResponse

handleSearchForPhotosCompletion

void handleSearchForPhotosCompletion(INSearchForPhotosIntent intent,
                                     INSearchForPhotosIntentHandling.Block_handleSearchForPhotosCompletion completion)

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

See Also:

INSearchForPhotosIntentResponse

resolveAlbumNameForSearchForPhotosWithCompletion

default void resolveAlbumNameForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent,
                                                              INSearchForPhotosIntentHandling.Block_resolveAlbumNameForSearchForPhotosWithCompletion completion)

resolveDateCreatedForSearchForPhotosWithCompletion

default void resolveDateCreatedForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent,
                                                                INSearchForPhotosIntentHandling.Block_resolveDateCreatedForSearchForPhotosWithCompletion 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

resolveLocationCreatedForSearchForPhotosWithCompletion

default void resolveLocationCreatedForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent,
                                                                    INSearchForPhotosIntentHandling.Block_resolveLocationCreatedForSearchForPhotosWithCompletion completion)

resolvePeopleInPhotoForSearchForPhotosWithCompletion

default void resolvePeopleInPhotoForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent,
                                                                  INSearchForPhotosIntentHandling.Block_resolvePeopleInPhotoForSearchForPhotosWithCompletion completion)

resolveSearchTermsForSearchForPhotosWithCompletion

default void resolveSearchTermsForSearchForPhotosWithCompletion(INSearchForPhotosIntent intent,
                                                                INSearchForPhotosIntentHandling.Block_resolveSearchTermsForSearchForPhotosWithCompletion completion)