apple.intents.protocol

Interface INPlayMediaIntentHandling

public interface INPlayMediaIntentHandling

Protocol to declare support for handling an INPlayMediaIntent. 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	INPlayMediaIntentHandling.Block_confirmPlayMediaCompletion
static interface	INPlayMediaIntentHandling.Block_handlePlayMediaCompletion
static interface	INPlayMediaIntentHandling.Block_resolveMediaItemsForPlayMediaWithCompletion
static interface	INPlayMediaIntentHandling.Block_resolvePlaybackQueueLocationForPlayMediaWithCompletion
static interface	INPlayMediaIntentHandling.Block_resolvePlaybackRepeatModeForPlayMediaWithCompletion
static interface	INPlayMediaIntentHandling.Block_resolvePlaybackSpeedForPlayMediaWithCompletion
static interface	INPlayMediaIntentHandling.Block_resolvePlayShuffledForPlayMediaWithCompletion
static interface	INPlayMediaIntentHandling.Block_resolveResumePlaybackForPlayMediaWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmPlayMediaCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_confirmPlayMediaCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handlePlayMediaCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_handlePlayMediaCompletion completion) Handling method - Execute the task represented by the INPlayMediaIntent that's passed in
default void	resolveMediaItemsForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolveMediaItemsForPlayMediaWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolvePlaybackQueueLocationForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolvePlaybackQueueLocationForPlayMediaWithCompletion completion)
default void	resolvePlaybackRepeatModeForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolvePlaybackRepeatModeForPlayMediaWithCompletion completion)
default void	resolvePlaybackSpeedForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolvePlaybackSpeedForPlayMediaWithCompletion completion)
default void	resolvePlayShuffledForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolvePlayShuffledForPlayMediaWithCompletion completion)
default void	resolveResumePlaybackForPlayMediaWithCompletion(INPlayMediaIntent intent, INPlayMediaIntentHandling.Block_resolveResumePlaybackForPlayMediaWithCompletion completion)

Method Detail

confirmPlayMediaCompletion

default void confirmPlayMediaCompletion(INPlayMediaIntent intent,
                                        INPlayMediaIntentHandling.Block_confirmPlayMediaCompletion 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 INPlayMediaIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INPlayMediaIntentResponse

handlePlayMediaCompletion

void handlePlayMediaCompletion(INPlayMediaIntent intent,
                               INPlayMediaIntentHandling.Block_handlePlayMediaCompletion completion)

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

See Also:

INPlayMediaIntentResponse

resolveMediaItemsForPlayMediaWithCompletion

default void resolveMediaItemsForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                         INPlayMediaIntentHandling.Block_resolveMediaItemsForPlayMediaWithCompletion 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

resolvePlayShuffledForPlayMediaWithCompletion

default void resolvePlayShuffledForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                           INPlayMediaIntentHandling.Block_resolvePlayShuffledForPlayMediaWithCompletion completion)

resolvePlaybackQueueLocationForPlayMediaWithCompletion

default void resolvePlaybackQueueLocationForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                                    INPlayMediaIntentHandling.Block_resolvePlaybackQueueLocationForPlayMediaWithCompletion completion)

resolvePlaybackRepeatModeForPlayMediaWithCompletion

default void resolvePlaybackRepeatModeForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                                 INPlayMediaIntentHandling.Block_resolvePlaybackRepeatModeForPlayMediaWithCompletion completion)

resolvePlaybackSpeedForPlayMediaWithCompletion

default void resolvePlaybackSpeedForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                            INPlayMediaIntentHandling.Block_resolvePlaybackSpeedForPlayMediaWithCompletion completion)

resolveResumePlaybackForPlayMediaWithCompletion

default void resolveResumePlaybackForPlayMediaWithCompletion(INPlayMediaIntent intent,
                                                             INPlayMediaIntentHandling.Block_resolveResumePlaybackForPlayMediaWithCompletion completion)