apple.intents.protocol

Interface INSetRadioStationIntentHandling

All Known Subinterfaces:

INRadioDomainHandling

public interface INSetRadioStationIntentHandling

Protocol to declare support for handling an INSetRadioStationIntent. 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	INSetRadioStationIntentHandling.Block_confirmSetRadioStationCompletion
static interface	INSetRadioStationIntentHandling.Block_handleSetRadioStationCompletion
static interface	INSetRadioStationIntentHandling.Block_resolveChannelForSetRadioStationWithCompletion
static interface	INSetRadioStationIntentHandling.Block_resolveFrequencyForSetRadioStationWithCompletion
static interface	INSetRadioStationIntentHandling.Block_resolvePresetNumberForSetRadioStationWithCompletion
static interface	INSetRadioStationIntentHandling.Block_resolveRadioTypeForSetRadioStationWithCompletion
static interface	INSetRadioStationIntentHandling.Block_resolveStationNameForSetRadioStationWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSetRadioStationCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_confirmSetRadioStationCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSetRadioStationCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_handleSetRadioStationCompletion completion) Handling method - Execute the task represented by the INSetRadioStationIntent that's passed in
default void	resolveChannelForSetRadioStationWithCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_resolveChannelForSetRadioStationWithCompletion completion)
default void	resolveFrequencyForSetRadioStationWithCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_resolveFrequencyForSetRadioStationWithCompletion completion)
default void	resolvePresetNumberForSetRadioStationWithCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_resolvePresetNumberForSetRadioStationWithCompletion completion)
default void	resolveRadioTypeForSetRadioStationWithCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_resolveRadioTypeForSetRadioStationWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveStationNameForSetRadioStationWithCompletion(INSetRadioStationIntent intent, INSetRadioStationIntentHandling.Block_resolveStationNameForSetRadioStationWithCompletion completion)

Method Detail

confirmSetRadioStationCompletion

default void confirmSetRadioStationCompletion(INSetRadioStationIntent intent,
                                              INSetRadioStationIntentHandling.Block_confirmSetRadioStationCompletion 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 INSetRadioStationIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSetRadioStationIntentResponse

handleSetRadioStationCompletion

void handleSetRadioStationCompletion(INSetRadioStationIntent intent,
                                     INSetRadioStationIntentHandling.Block_handleSetRadioStationCompletion completion)

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

See Also:

INSetRadioStationIntentResponse

resolveChannelForSetRadioStationWithCompletion

default void resolveChannelForSetRadioStationWithCompletion(INSetRadioStationIntent intent,
                                                            INSetRadioStationIntentHandling.Block_resolveChannelForSetRadioStationWithCompletion completion)

resolveFrequencyForSetRadioStationWithCompletion

default void resolveFrequencyForSetRadioStationWithCompletion(INSetRadioStationIntent intent,
                                                              INSetRadioStationIntentHandling.Block_resolveFrequencyForSetRadioStationWithCompletion completion)

resolvePresetNumberForSetRadioStationWithCompletion

default void resolvePresetNumberForSetRadioStationWithCompletion(INSetRadioStationIntent intent,
                                                                 INSetRadioStationIntentHandling.Block_resolvePresetNumberForSetRadioStationWithCompletion completion)

resolveRadioTypeForSetRadioStationWithCompletion

default void resolveRadioTypeForSetRadioStationWithCompletion(INSetRadioStationIntent intent,
                                                              INSetRadioStationIntentHandling.Block_resolveRadioTypeForSetRadioStationWithCompletion 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

resolveStationNameForSetRadioStationWithCompletion

default void resolveStationNameForSetRadioStationWithCompletion(INSetRadioStationIntent intent,
                                                                INSetRadioStationIntentHandling.Block_resolveStationNameForSetRadioStationWithCompletion completion)