apple.intents.protocol

Interface INStartPhotoPlaybackIntentHandling

All Known Subinterfaces:

INPhotosDomainHandling

public interface INStartPhotoPlaybackIntentHandling

Protocol to declare support for handling an INStartPhotoPlaybackIntent. 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	INStartPhotoPlaybackIntentHandling.Block_confirmStartPhotoPlaybackCompletion
static interface	INStartPhotoPlaybackIntentHandling.Block_handleStartPhotoPlaybackCompletion
static interface	INStartPhotoPlaybackIntentHandling.Block_resolveAlbumNameForStartPhotoPlaybackWithCompletion
static interface	INStartPhotoPlaybackIntentHandling.Block_resolveDateCreatedForStartPhotoPlaybackWithCompletion
static interface	INStartPhotoPlaybackIntentHandling.Block_resolveLocationCreatedForStartPhotoPlaybackWithCompletion
static interface	INStartPhotoPlaybackIntentHandling.Block_resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmStartPhotoPlaybackCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_confirmStartPhotoPlaybackCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleStartPhotoPlaybackCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_handleStartPhotoPlaybackCompletion completion) Handling method - Execute the task represented by the INStartPhotoPlaybackIntent that's passed in
default void	resolveAlbumNameForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_resolveAlbumNameForStartPhotoPlaybackWithCompletion completion)
default void	resolveDateCreatedForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_resolveDateCreatedForStartPhotoPlaybackWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveLocationCreatedForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_resolveLocationCreatedForStartPhotoPlaybackWithCompletion completion)
default void	resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent, INStartPhotoPlaybackIntentHandling.Block_resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion completion)

Method Detail

confirmStartPhotoPlaybackCompletion

default void confirmStartPhotoPlaybackCompletion(INStartPhotoPlaybackIntent intent,
                                                 INStartPhotoPlaybackIntentHandling.Block_confirmStartPhotoPlaybackCompletion 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 INStartPhotoPlaybackIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INStartPhotoPlaybackIntentResponse

handleStartPhotoPlaybackCompletion

void handleStartPhotoPlaybackCompletion(INStartPhotoPlaybackIntent intent,
                                        INStartPhotoPlaybackIntentHandling.Block_handleStartPhotoPlaybackCompletion completion)

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

See Also:

INStartPhotoPlaybackIntentResponse

resolveAlbumNameForStartPhotoPlaybackWithCompletion

default void resolveAlbumNameForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent,
                                                                 INStartPhotoPlaybackIntentHandling.Block_resolveAlbumNameForStartPhotoPlaybackWithCompletion completion)

resolveDateCreatedForStartPhotoPlaybackWithCompletion

default void resolveDateCreatedForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent,
                                                                   INStartPhotoPlaybackIntentHandling.Block_resolveDateCreatedForStartPhotoPlaybackWithCompletion 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

resolveLocationCreatedForStartPhotoPlaybackWithCompletion

default void resolveLocationCreatedForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent,
                                                                       INStartPhotoPlaybackIntentHandling.Block_resolveLocationCreatedForStartPhotoPlaybackWithCompletion completion)

resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion

default void resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion(INStartPhotoPlaybackIntent intent,
                                                                     INStartPhotoPlaybackIntentHandling.Block_resolvePeopleInPhotoForStartPhotoPlaybackWithCompletion completion)